timescope 0.0.0-alpha.5 → 0.0.0-alpha.6

package/index.d.ts

@@ -105,7 +105,7 @@ declare namespace Decimal {
 type NumberLike = string | bigint | number | DecimalInstance;
 //#endregion
 //#region src/core/range.d.ts
-type Range<T> = [T, T];
+type TimescopeRange<T> = [T, T];
 //#endregion
 //#region src/core/chunk.d.ts
 /**
@@ -119,7 +119,7 @@ type TimescopeDataChunkDesc = {
   /** Expiration timestamp (ms). */
   expires?: number;
   /** Time range covered by this chunk. */
-  range: Range<Decimal | undefined>;
+  range: TimescopeRange<Decimal | undefined>;
   /** Resolution in milliseconds per sample. */
   resolution: Decimal;
   /** Zoom level. */
@@ -198,9 +198,9 @@ type ZoomLike = NumberLike;
 //#region src/core/TimescopeState.d.ts
 interface TimescopeStateOptions {
   time?: TimeLike;
-  timeRange?: Range<TimeLike | null | undefined>;
+  timeRange?: TimescopeRange<TimeLike | null | undefined>;
   zoom?: ZoomLike;
-  zoomRange?: Range<ZoomLike | undefined>;
+  zoomRange?: TimescopeRange<ZoomLike | undefined>;
 }
 //#endregion
 //#region src/core/types.d.ts
@@ -314,10 +314,10 @@ type TimescopeSeriesInput<Source extends Record<string, TimescopeSourceInput>, S
     digits?: number;
     color?: string;
     scale?: 'linear' | 'log';
-    range?: NumberLike | Range<NumberLike | undefined> | {
+    range?: NumberLike | TimescopeRange<NumberLike | undefined> | {
       expand?: boolean;
       shrink?: boolean;
-      default?: NumberLike | Range<NumberLike | undefined>;
+      default?: NumberLike | TimescopeRange<NumberLike | undefined>;
     };
     instantaneous?: {
       using?: Using1<[InferTimeKey<TimeDef>, InferValueKey<ValueDef>]>;
@@ -396,7 +396,7 @@ type TimescopeOptionsSelection = boolean | {
   resizable?: boolean;
   color?: string;
   invert?: boolean;
-  range?: Range<Decimal | undefined> | null;
+  range?: TimescopeRange<Decimal | undefined> | null;
 };
 type TimescopeOptions<Source extends Record<string, TimescopeSourceInput> = Record<string, TimescopeSourceInput>, SourceName extends Record<string, keyof Source> = Record<string, keyof Source>, TimeDef extends Record<string, FieldDefLike<TimeLike<never>>> = Record<string, FieldDefLike<TimeLike<never>>>, ValueDef extends Record<string, FieldDefLike<NumberLike | null>> = Record<string, FieldDefLike<NumberLike | null>>, Track extends string = string> = {
   style?: TimescopeStyle;
@@ -423,6 +423,16 @@ declare const defineTimescopeTracks: <Track extends string>(opts: TimescopeOptio
 declare const defineTimescopeSeries: <Source extends Record<string, TimescopeSourceInput>, SourceName extends Record<string, keyof Source>, TimeDef extends Record<string, FieldDefLike<TimeLike<never>>>, ValueDef extends Record<string, FieldDefLike<NumberLike | null>>, Track extends string = "default">(opts: TimescopeOptionsSeries<Source, SourceName, TimeDef, ValueDef, Track>, sources?: TimescopeOptionsSources<Source>, tracks?: TimescopeOptionsTracks<Track>) => typeof opts;
 //#endregion
 //#region src/main/Timescope.d.ts
+type TimescopeSize = {
+  /** Canvas x position in the viewport. */
+  x: number;
+  /** Canvas y position in the viewport. */
+  y: number;
+  /** Canvas width in CSS pixels. */
+  width: number;
+  /** Canvas height in CSS pixels. */
+  height: number;
+};
 type TimescopeUpdateOptions<Source extends Record<string, TimescopeSourceInput>, SourceName extends Record<string, keyof Source>, TimeDef extends Record<string, FieldDefLike<TimeLike<never>>>, ValueDef extends Record<string, FieldDefLike<NumberLike | null>>, Track extends string> = Omit<TimescopeOptions<Source, SourceName, TimeDef, ValueDef, Track>, 'series'> & {
   series?: { [K in keyof SourceName & keyof TimeDef & keyof ValueDef]: Omit<TimescopeSeriesInput<Source, SourceName[K] & string, TimeDef[K], ValueDef[K], Track>, 'data'> & {
     data: Omit<TimescopeSeriesInput<Source, SourceName[K] & string, TimeDef[K], ValueDef[K], Track>['data'], 'source'> & {
@@ -434,24 +444,24 @@ type TimescopeFitOptions = {
   animation?: boolean;
   padding?: number | [l: number, r: number];
 };
-declare class Timescope<Source extends Record<string, TimescopeSourceInput> = Record<string, TimescopeSourceInput>, SourceName extends Record<string, keyof Source> = Record<string, keyof Source>, TimeDef extends Record<string, FieldDefLike<TimeLike<never>>> = Record<string, FieldDefLike<TimeLike<never>>>, ValueDef extends Record<string, FieldDefLike<NumberLike | null>> = Record<string, FieldDefLike<NumberLike | null>>, Track extends string = string> extends TimescopeObservable<TimescopeEvent<'timechanging', Decimal | null> | TimescopeEvent<'timechanged', Decimal | null> | TimescopeEvent<'timeanimating', Decimal | null> | TimescopeEvent<'zoomchanging', number> | TimescopeEvent<'zoomchanged', number> | TimescopeEvent<'zoomanimating', number> | TimescopeEvent<'rangechanging', Range<Decimal>> | TimescopeEvent<'rangechanged', Range<Decimal> | null>> {
+declare class Timescope<Source extends Record<string, TimescopeSourceInput> = Record<string, TimescopeSourceInput>, SourceName extends Record<string, keyof Source> = Record<string, keyof Source>, TimeDef extends Record<string, FieldDefLike<TimeLike<never>>> = Record<string, FieldDefLike<TimeLike<never>>>, ValueDef extends Record<string, FieldDefLike<NumberLike | null>> = Record<string, FieldDefLike<NumberLike | null>>, Track extends string = string> extends TimescopeObservable<TimescopeEvent<'timechanging', Decimal | null> | TimescopeEvent<'timechanged', Decimal | null> | TimescopeEvent<'timeanimating', Decimal | null> | TimescopeEvent<'zoomchanging', number> | TimescopeEvent<'zoomchanged', number> | TimescopeEvent<'zoomanimating', number> | TimescopeEvent<'rangechanging', TimescopeRange<Decimal>> | TimescopeEvent<'rangechanged', TimescopeRange<Decimal> | null>> {
   #private;
   get time(): Decimal | null;
   set time(v: TimeLike | null);
-  setTime(v: TimeLike | null, animation?: TimescopeAnimationInput): void;
+  setTime(v: TimeLike | null, animation?: TimescopeAnimationInput): boolean;
   get timeChanging(): Decimal | null;
   get timeAnimating(): Decimal | null;
-  get timeRange(): Range<Decimal | null | undefined>;
-  setTimeRange(domain?: Range<TimeLike | null | undefined>): void;
+  get timeRange(): TimescopeRange<Decimal | null | undefined>;
+  setTimeRange(domain?: TimescopeRange<TimeLike | null | undefined>): void;
   get zoom(): number;
   set zoom(v: ZoomLike);
   setZoom(v: ZoomLike, animation?: TimescopeAnimationInput): boolean;
   get zoomChanging(): number;
   get zoomAnimating(): number;
-  fitTo(range: Range<TimeLike<never>>, opts?: TimescopeFitOptions): false | undefined;
-  get zoomRange(): Range<number | undefined>;
-  setZoomRange(domain?: Range<ZoomLike | undefined>): void;
-  setSelection(domain: Range<TimeLike<undefined>> | null): void;
+  fitTo(range: TimescopeRange<TimeLike<never>>, opts?: TimescopeFitOptions): boolean;
+  get zoomRange(): TimescopeRange<number | undefined>;
+  setZoomRange(domain?: TimescopeRange<ZoomLike | undefined>): void;
+  setSelection(domain: TimescopeRange<TimeLike<undefined>> | null): void;
   clearSelection(): void;
   get animating(): boolean;
   get editing(): boolean;
@@ -469,9 +479,10 @@ declare class Timescope<Source extends Record<string, TimescopeSourceInput> = Re
   updateOptions(opts: TimescopeUpdateOptions<Source, SourceName, TimeDef, ValueDef, Track>): void;
   constructor(opts?: TimescopeOptionsInitial<Source, SourceName, TimeDef, ValueDef, Track>);
   reload(sources?: (keyof SourceName & string)[]): void;
+  redraw(): void;
   mount(target: HTMLElement | string): this;
   unmount(): void;
   dispose(): void;
 }
 //#endregion
-export { AngleStyle, BoxStyle, CalendarLevel, Decimal, type DecimalLike, FieldDefLike, FillStyle, IconStyle, OffsetStyle, PathStyle, SizeStyle, StrokeStyle, TextStyle, TimeFormatFunc, TimeFormatFuncOptions, TimeFormatLabeler, TimeFormatLabelerOptions, Timescope, TimescopeChartLink, TimescopeChartMark, TimescopeChartStyleEntry, TimescopeChartType, type NumberLike as TimescopeNumberLike, type TimescopeOptions, type TimescopeOptionsInitial, TimescopeOptionsSelection, TimescopeOptionsSeries, TimescopeOptionsSources, TimescopeOptionsTracks, TimescopeSeriesInput, TimescopeSourceCommonOptions, TimescopeSourceInput, TimescopeSourceOptions, TimescopeTimeAxisOptions, type TimeLike as TimescopeTimeLike, Using, Using1, Using2, createDefineTimescopeOptions, createDefineTimescopeSeries, createDefineTimescopeSources, createDefineTimescopeTracks, defineTimescopeOptions, defineTimescopeSeries, defineTimescopeSources, defineTimescopeTracks };
+export { AngleStyle, BoxStyle, CalendarLevel, Decimal, type DecimalLike, FieldDefLike, FillStyle, IconStyle, OffsetStyle, PathStyle, SizeStyle, StrokeStyle, TextStyle, TimeFormatFunc, TimeFormatFuncOptions, TimeFormatLabeler, TimeFormatLabelerOptions, Timescope, type TimescopeAnimationInput, TimescopeChartLink, TimescopeChartMark, TimescopeChartStyleEntry, TimescopeChartType, TimescopeFitOptions, type NumberLike as TimescopeNumberLike, type TimescopeOptions, type TimescopeOptionsInitial, TimescopeOptionsSelection, TimescopeOptionsSeries, TimescopeOptionsSources, TimescopeOptionsTracks, type TimescopeRange, TimescopeSeriesInput, TimescopeSize, TimescopeSourceCommonOptions, TimescopeSourceInput, TimescopeSourceOptions, TimescopeTimeAxisOptions, type TimeLike as TimescopeTimeLike, Using, Using1, Using2, createDefineTimescopeOptions, createDefineTimescopeSeries, createDefineTimescopeSources, createDefineTimescopeTracks, defineTimescopeOptions, defineTimescopeSeries, defineTimescopeSources, defineTimescopeTracks };