Tighten up a few types

Author: camdecoster

src/types/core/api.d.ts

@@ -19,8 +19,8 @@ import type { Icon, Template } from './layout';
 export type Root = string | HTMLElement;
 
 /**
- * Figure-shaped object accepted by `toImage`/`downloadImage` when called
- * without an attached graph div.
+ * Figure-shaped object accepted by `newPlot` (in the `data` position) and
+ * by `toImage`/`downloadImage` when called without an attached graph div.
  */
 export interface PlotlyDataLayoutConfig {
     /** Trace data array. */
@@ -29,6 +29,8 @@ export interface PlotlyDataLayoutConfig {
     layout?: Partial<Layout>;
     /** Optional config overrides. */
     config?: Partial<Config>;
+    /** Optional animation frames. */
+    frames?: Frame[];
 }
 
 /** Either a regular root target or a figure-shaped object. */
@@ -46,34 +48,34 @@ export interface StaticPlots {
 
 /** Names of icons bundled with Plotly's mode-bar. */
 export type DefaultIcons =
-    | 'undo'
-    | 'home'
-    | 'camera-retro'
-    | 'zoombox'
-    | 'pan'
-    | 'zoom_plus'
-    | 'zoom_minus'
-    | 'autoscale'
-    | 'tooltip_basic'
-    | 'tooltip_compare'
-    | 'plotlylogo'
-    | 'z-axis'
     | '3d_rotate'
+    | 'autoscale'
+    | 'camera-retro'
     | 'camera'
-    | 'movie'
-    | 'question'
     | 'disk'
-    | 'drawopenpath'
+    | 'drawcircle'
     | 'drawclosedpath'
-    | 'lasso'
-    | 'selectbox'
     | 'drawline'
+    | 'drawopenpath'
     | 'drawrect'
-    | 'drawcircle'
     | 'eraseshape'
-    | 'spikeline'
+    | 'home'
+    | 'lasso'
+    | 'movie'
+    | 'newplotlylogo'
+    | 'pan'
     | 'pencil'
-    | 'newplotlylogo';
+    | 'plotlylogo'
+    | 'question'
+    | 'selectbox'
+    | 'spikeline'
+    | 'tooltip_basic'
+    | 'tooltip_compare'
+    | 'undo'
+    | 'z-axis'
+    | 'zoom_minus'
+    | 'zoom_plus'
+    | 'zoombox';
 
 /** Map of built-in icon name → `Icon` definition. */
 export type IconsMap = { [K in DefaultIcons]: Icon };
@@ -194,6 +196,18 @@ export function newPlot(
     layout?: Partial<Layout>,
     config?: Partial<Config>
 ): Promise<PlotlyHTMLElement>;
+/**
+ * Create a new plot at `root` from a figure-shaped object containing
+ * `data`/`layout`/`config`/`frames`. Replaces any existing plot.
+ *
+ * @param root - graph div id or element
+ * @param figure - figure-shaped object
+ * @returns the graph div once the plot has rendered
+ */
+export function newPlot(
+    root: Root,
+    figure: PlotlyDataLayoutConfig
+): Promise<PlotlyHTMLElement>;
 
 /** Update layout properties on an existing plot. */
 export function relayout(root: Root, layout: Partial<Layout>): Promise<PlotlyHTMLElement>;

src/types/core/data.internal.d.ts

@@ -5,6 +5,7 @@
  * properties. For public trace types, see data.d.ts.
  */
 
+import type { Datum } from '../lib/common';
 import type { Data } from './data';
 
 /**
@@ -21,11 +22,11 @@ export interface CalcData {
     /** Back-reference to the fully-populated trace this calcdata belongs to. */
     trace?: FullData;
     /** Computed x coordinate(s). */
-    x?: any;
+    x?: Datum | Datum[];
     /** Computed y coordinate(s). */
-    y?: any;
+    y?: Datum | Datum[];
     /** Computed z coordinate(s) (for 3-D traces). */
-    z?: any;
+    z?: Datum | Datum[];
     /** Trace-module-specific calc fields. */
     [key: string]: any;
 }
@@ -43,13 +44,13 @@ interface FullDataInternals {
     /** Cached extremes (per axis) for autorange computation. */
     _extremes?: Record<string, any>;
     /** Snapshot of the trace before transforms were applied. */
-    _fullInput?: any;
+    _fullInput?: Data;
     /** True when the trace has a transform that affects `calcdata`. */
     _hasCalcTransform?: boolean;
     /** Map from `_expandedIndex` back to original point indices. */
     _indexToPoints?: { [key: number]: number[] };
     /** Original user-supplied trace object (pre-defaults). */
-    _input?: any;
+    _input?: Data;
     /** Length of the trace's data arrays (after coercion). */
     _length?: number;
     /** Captured `meta` references from trace and layout for template binding. */

src/types/core/layout.internal.d.ts

@@ -9,6 +9,7 @@
 import type { Locale, Selection } from 'd3';
 import type { Layout } from '../generated/schema';
 import type { Color } from '../lib/common';
+import type { GraphDiv } from './graph-div.internal';
 
 /**
  * Fully processed layout with all defaults applied (internal use).
@@ -22,7 +23,7 @@ export interface FullLayout extends Layout {
     /** Resolved list of base-plot modules in use (cartesian, polar, …). */
     _basePlotModules?: any[];
     /** Recomputes inverse-transform caches after a transform change. */
-    _calcInverseTransform?: (gd: any) => void;
+    _calcInverseTransform?: (gd: GraphDiv) => void;
     /** True once initial autosize has completed at least once. */
     _initialAutoSizeIsDone?: boolean;
     /** Cached inverse CSS transform for hit-testing. */
@@ -242,9 +243,9 @@ export interface FullLayout extends Layout {
     /** Index of the active shape in `layout.shapes`. */
     _activeShapeIndex?: number;
     /** Callback to deactivate the active selection. */
-    _deactivateSelection?: (gd: any) => void;
+    _deactivateSelection?: (gd: GraphDiv) => void;
     /** Callback to deactivate the active shape. */
-    _deactivateShape?: (gd: any) => void;
+    _deactivateShape?: (gd: GraphDiv) => void;
     /** Cached deselect callback. */
     _deselect?: any;
     /** Vertical offset for colorbar title repositioning. */