@spidunno/desmos-types 1.13.7 → 1.13.8

package/module/index.d.ts

@@ -2044,7 +2044,7 @@ declare namespace Desmos {
     /** Set global MathQuill configuration. */
     config(config: MathQuillConfig): void;
     /** The MathQuill API instance attached to `element`, if any. */
-    getApiInstanceForElement(element: HTMLElement): MathQuillStaticMath | MathQuillMathField | null | undefined;
+    getApiInstanceForElement(element: Element): MathQuillStaticMath | MathQuillMathField | null | undefined;
   }
 
   /** @remarks Undocumented: may change without notice. */

package/module/internals.d.ts

@@ -2044,7 +2044,7 @@ declare namespace Desmos {
     /** Set global MathQuill configuration. */
     config(config: MathQuillConfig): void;
     /** The MathQuill API instance attached to `element`, if any. */
-    getApiInstanceForElement(element: HTMLElement): MathQuillStaticMath | MathQuillMathField | null | undefined;
+    getApiInstanceForElement(element: Element): MathQuillStaticMath | MathQuillMathField | null | undefined;
   }
 
   /** @remarks Undocumented: may change without notice. */
@@ -7300,6 +7300,55 @@ declare namespace Desmos.Internals {
     };
   }
 
+  // ---------------------------------------------------------------------------
+  // Grid layer
+  // ---------------------------------------------------------------------------
+
+  /**
+   * Grid spacing in math units: the axis step settings if they fit, otherwise
+   * steps picked so the axis numbers don't overlap. A minor step of 0 means no
+   * minor lines; both are NaN on a logarithmic axis.
+   */
+  interface GridSteps {
+    majorStepX: number;
+    minorStepX: number;
+    majorStepY: number;
+    minorStepY: number;
+  }
+
+  /** Where a logarithmic axis draws its lines (a linear axis has empty lists). */
+  interface LogAxisGrid {
+    label: number[];
+    major: number[];
+    minor: number[];
+    /** Multiplies the minor line opacity; fades minor lines as decades shrink. */
+    unitOpacity: number;
+  }
+
+  interface LogGrid {
+    x: LogAxisGrid;
+    y: LogAxisGrid;
+  }
+
+  /**
+   * `grapher2d.gridLayer` (also `privateGetGridLayer()`): draws the grid,
+   * axes and axis numbers, under every graph.
+   *
+   * Lines are drawn 1px wide at `Math.round(px - 0.5) + 0.5`, in the text
+   * color: minor lines at `minorAxisOpacity`, then major lines over them at
+   * an opacity that composites to `majorAxisOpacity`. Lines on the edges of
+   * the screen, and at 0 when that axis is shown, are skipped.
+   */
+  interface GridLayer extends Generated.Grapher2DGridLayer {
+    /**
+     * Draw the whole layer. The main redraw passes `grapher2d.scaleAxis`
+     * (the axis being dragged, highlighted); screenshots pass only `context`.
+     */
+    redrawToCtx(context: DrawContext, scaleAxis?: 'x' | 'y' | 'both'): void;
+    drawCartesianGrid(ctx: CanvasRenderingContext2D, projection: Projection, steps: GridSteps, logGrid?: LogGrid): void;
+    drawPolarGrid(ctx: CanvasRenderingContext2D, projection: Projection, steps: { majorStepR: number; minorStepR: number }): void;
+  }
+
   /**
    * Options accepted by the grapher's own screenshot methods. The public
    * `asyncScreenshot` handles `mode` and `mathBounds` itself and passes the
@@ -7413,6 +7462,9 @@ declare namespace Desmos.Internals {
     settings: GrapherSettings;
     events: GrapherEvents;
     viewportController: ViewportController;
+    /** Draws the grid, axes and axis numbers. */
+    gridLayer: GridLayer;
+    privateGetGridLayer(): GridLayer;
     __projection: Projection;
     /** The viewport at the last animation frame (unset before the first one); used to detect viewport changes. */
     lastTickViewport?: Viewport;
@@ -7754,7 +7806,63 @@ declare namespace Desmos.Internals {
     controller: Controller;
   }
 
-  interface Grapher3D extends Generated.Grapher3D {}
+  /** A point in 3D math coordinates. */
+  interface Point3D {
+    x: number;
+    y: number;
+    z: number;
+  }
+
+  /** What the 3D grapher's worker found under the mouse. */
+  interface PickResult3D {
+    /** Where the ray from the mouse hit, in math coordinates. */
+    point: Point3D;
+  }
+
+  /** `grapher3d.controls`: mouse, touch and keyboard handling for the 3D graph paper. */
+  interface Grapher3DControls {
+    grapher3d: Grapher3D;
+    /** The graph paper element (`grapher3d.elt`). Desmos's wheel handler is attached here. */
+    domElement: HTMLElement;
+    /** -1 when idle, 0 while rotating with the mouse. */
+    state: -1 | 0;
+    /** Rotation speed while the graph is spinning, 0 when it isn't. */
+    speed3D: number;
+    /**
+     * `performance.now()` of the last wheel zoom, or 0. The tick calls
+     * `grapher3d.endZoom()` and resets it 100ms after the last one.
+     */
+    lastWheelEventTime: number;
+    /** Whether zoom and pan are disabled. */
+    isLocked(): boolean;
+    /** Whether rotating is disabled (the user lock, or the page is pinch zoomed). */
+    isRotationLocked(): boolean;
+    /** Set the viewport and commit it to history after a short delay. */
+    updateViewport(viewport: ViewportObject): void;
+  }
+
+  /** `grapher3d.viewportController`. */
+  interface Grapher3DViewportController {
+    getViewport(): Viewport;
+    /**
+     * Jump to a viewport. Invalid axes keep their current bounds, and each
+     * axis is clamped to a width between 1.34e-4 × its largest bound (at
+     * least 1.34e-4) and 134000, within ±67000.
+     */
+    setCurrentViewport(viewport: ViewportObject): void;
+  }
+
+  interface Grapher3D extends Generated.Grapher3D {
+    controls: Grapher3DControls;
+    viewportController: Grapher3DViewportController;
+    /** The 3D viewport always has z bounds (Desmos fills in defaults). */
+    getProjection(): { viewport: Viewport & { zmin: number; zmax: number } };
+    /**
+     * What's under the mouse, used as the center when zooming in with the
+     * scroll wheel. Undefined while the graph is spinning, or over nothing.
+     */
+    getZoomScrollWheelPickResult(): PickResult3D | null | undefined;
+  }
 
   interface Evaluator extends Generated.Evaluator {}
 
@@ -8165,6 +8273,17 @@ declare namespace Desmos.Internals {
 
   type FragileViewClass<P, Members> = DCGView.ViewClass<P, FragileView<P, Members>>;
 
+  /** Static helpers on `Fragile.MathquillView`. */
+  interface MathquillViewStatics {
+    /** The math field containing `document.activeElement`, if it's in one. */
+    getFocusedMathquill(): Desmos.MathQuillMathField | undefined;
+    /**
+     * Apply an arrow key to a math field. Returns true if the cursor was
+     * already at that edge (so focus should move to the next item).
+     */
+    applyArrowKeyAndReturnIfWasAtBounds(mathField: Desmos.MathQuillMathField, key: string, event: KeyboardEvent): boolean;
+  }
+
   /** The view classes on `Private.Fragile`. */
   interface FragileViews {
     ExpressionView: FragileViewClass<ExpressionViewProps, Generated.ExpressionViewMembers>;
@@ -8173,7 +8292,7 @@ declare namespace Desmos.Internals {
     ExpressionOptionsMenuView: FragileViewClass<ExpressionOptionsMenuViewProps, Generated.ExpressionOptionsMenuViewMembers>;
     ImageIconView: FragileViewClass<ImageIconViewProps, Generated.ImageIconViewMembers>;
     PromptSliderView: FragileViewClass<PromptSliderViewProps, Generated.PromptSliderViewMembers>;
-    MathquillView: FragileViewClass<MathquillViewProps, Generated.MathquillViewMembers>;
+    MathquillView: FragileViewClass<MathquillViewProps, Generated.MathquillViewMembers> & MathquillViewStatics;
     InlineMathInputView: FragileViewClass<InlineMathInputViewProps, Generated.InlineMathInputViewMembers>;
     StaticMathquillView: FragileViewClass<StaticMathquillViewProps, Generated.StaticMathquillViewMembers>;
     Checkbox: FragileViewClass<CheckboxProps, Generated.CheckboxMembers>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@spidunno/desmos-types",
-  "version": "1.13.7",
+  "version": "1.13.8",
   "description": "TypeScript type definitions for the Desmos API v1.13",
   "types": "index.d.ts",
   "publishConfig": {

package/types/mathquill.d.ts

@@ -52,7 +52,7 @@ declare namespace Desmos {
     /** Set global MathQuill configuration. */
     config(config: MathQuillConfig): void;
     /** The MathQuill API instance attached to `element`, if any. */
-    getApiInstanceForElement(element: HTMLElement): MathQuillStaticMath | MathQuillMathField | null | undefined;
+    getApiInstanceForElement(element: Element): MathQuillStaticMath | MathQuillMathField | null | undefined;
   }
 
   /** @remarks Undocumented: may change without notice. */