@excalidraw/math 0.18.0-4a5c9e9 → 0.18.0-4ce8305

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (246) hide show
  1. package/dist/dev/index.js +313 -115
  2. package/dist/dev/index.js.map +4 -4
  3. package/dist/prod/index.js +1 -1
  4. package/dist/types/common/src/colors.d.ts +23 -1
  5. package/dist/types/common/src/constants.d.ts +66 -7
  6. package/dist/types/common/src/keys.d.ts +4 -0
  7. package/dist/types/common/src/points.d.ts +1 -1
  8. package/dist/types/common/src/random.d.ts +7 -0
  9. package/dist/types/common/src/utils.d.ts +13 -44
  10. package/dist/types/element/src/Scene.d.ts +7 -5
  11. package/dist/types/element/src/align.d.ts +5 -2
  12. package/dist/types/element/src/arrowEndpointText.d.ts +49 -0
  13. package/dist/types/element/src/arrows/focus.d.ts +5 -2
  14. package/dist/types/element/src/binding.d.ts +64 -13
  15. package/dist/types/element/src/bounds.d.ts +31 -8
  16. package/dist/types/element/src/bucketFill.d.ts +110 -0
  17. package/dist/types/element/src/collision.d.ts +21 -5
  18. package/dist/types/element/src/comparisons.d.ts +8 -5
  19. package/dist/types/element/src/convertToShape.d.ts +23 -0
  20. package/dist/types/element/src/cropElement.d.ts +36 -4
  21. package/dist/types/element/src/delta.d.ts +30 -2
  22. package/dist/types/element/src/distribute.d.ts +5 -2
  23. package/dist/types/element/src/dragElements.d.ts +34 -2
  24. package/dist/types/element/src/duplicate.d.ts +64 -3
  25. package/dist/types/element/src/elbowArrow.d.ts +5 -0
  26. package/dist/types/element/src/embeddable.d.ts +3 -2
  27. package/dist/types/element/src/flowchart.d.ts +11 -7
  28. package/dist/types/element/src/fractionalIndex.d.ts +2 -2
  29. package/dist/types/element/src/frame.d.ts +11 -10
  30. package/dist/types/element/src/groups.d.ts +10 -15
  31. package/dist/types/element/src/image.d.ts +5 -2
  32. package/dist/types/element/src/index.d.ts +7 -1
  33. package/dist/types/element/src/linearElementEditor.d.ts +31 -11
  34. package/dist/types/element/src/listMarker.d.ts +39 -0
  35. package/dist/types/element/src/mutateElement.d.ts +1 -1
  36. package/dist/types/element/src/newElement.d.ts +55 -3
  37. package/dist/types/element/src/renderElement.d.ts +31 -7
  38. package/dist/types/element/src/renderEnvironment.d.ts +66 -0
  39. package/dist/types/element/src/resizeElements.d.ts +14 -4
  40. package/dist/types/element/src/selection.d.ts +6 -12
  41. package/dist/types/element/src/shape.d.ts +29 -1
  42. package/dist/types/element/src/sizeHelpers.d.ts +6 -0
  43. package/dist/types/element/src/sortElements.d.ts +10 -0
  44. package/dist/types/element/src/stickyNote.d.ts +191 -0
  45. package/dist/types/element/src/textElement.d.ts +22 -10
  46. package/dist/types/element/src/textMeasurements.d.ts +15 -11
  47. package/dist/types/element/src/textWrapping.d.ts +3 -2
  48. package/dist/types/element/src/transform.d.ts +31 -8
  49. package/dist/types/element/src/typeChecks.d.ts +29 -27
  50. package/dist/types/element/src/types.d.ts +43 -7
  51. package/dist/types/element/src/utils.d.ts +15 -4
  52. package/dist/types/element/src/zindex.d.ts +2 -2
  53. package/dist/types/excalidraw/actions/actionAddToLibrary.d.ts +87 -18
  54. package/dist/types/excalidraw/actions/actionAlign.d.ts +6 -6
  55. package/dist/types/excalidraw/actions/actionBoundText.d.ts +74 -203
  56. package/dist/types/excalidraw/actions/actionCanvas.d.ts +271 -946
  57. package/dist/types/excalidraw/actions/actionClipboard.d.ts +58 -12
  58. package/dist/types/excalidraw/actions/actionCropEditor.d.ts +29 -6
  59. package/dist/types/excalidraw/actions/actionDeleteSelected.d.ts +4 -518
  60. package/dist/types/excalidraw/actions/actionDeselect.d.ts +31 -8
  61. package/dist/types/excalidraw/actions/actionDistribute.d.ts +2 -3
  62. package/dist/types/excalidraw/actions/actionElementLink.d.ts +29 -6
  63. package/dist/types/excalidraw/actions/actionElementLock.d.ts +59 -13
  64. package/dist/types/excalidraw/actions/actionExport.d.ts +66 -20
  65. package/dist/types/excalidraw/actions/actionFinalize.d.ts +1 -0
  66. package/dist/types/excalidraw/actions/actionFrame.d.ts +114 -651
  67. package/dist/types/excalidraw/actions/actionGroup.d.ts +73 -27
  68. package/dist/types/excalidraw/actions/actionLinearEditor.d.ts +84 -9
  69. package/dist/types/excalidraw/actions/actionLink.d.ts +30 -7
  70. package/dist/types/excalidraw/actions/actionMenu.d.ts +29 -6
  71. package/dist/types/excalidraw/actions/actionProperties.d.ts +96 -34
  72. package/dist/types/excalidraw/actions/actionSelectAll.d.ts +35 -12
  73. package/dist/types/excalidraw/actions/actionStyles.d.ts +30 -7
  74. package/dist/types/excalidraw/actions/actionTextAutoResize.d.ts +1 -1
  75. package/dist/types/excalidraw/actions/actionToggleArrowBinding.d.ts +30 -7
  76. package/dist/types/excalidraw/actions/actionToggleGridMode.d.ts +33 -11
  77. package/dist/types/excalidraw/actions/actionToggleMidpointSnapping.d.ts +30 -7
  78. package/dist/types/excalidraw/actions/actionToggleObjectsSnapMode.d.ts +30 -7
  79. package/dist/types/excalidraw/actions/actionToggleSearchMenu.d.ts +33 -11
  80. package/dist/types/excalidraw/actions/actionToggleShapeSwitch.d.ts +1 -1
  81. package/dist/types/excalidraw/actions/{actionEmbeddable.d.ts → actionToggleShowHints.d.ts} +45 -19
  82. package/dist/types/excalidraw/actions/actionToggleStats.d.ts +30 -7
  83. package/dist/types/excalidraw/actions/actionToggleViewMode.d.ts +31 -8
  84. package/dist/types/excalidraw/actions/actionToggleWrap.d.ts +12 -0
  85. package/dist/types/excalidraw/actions/actionToggleZenMode.d.ts +30 -7
  86. package/dist/types/excalidraw/actions/colorTargets.d.ts +39 -0
  87. package/dist/types/excalidraw/actions/index.d.ts +3 -2
  88. package/dist/types/excalidraw/actions/manager.d.ts +1 -0
  89. package/dist/types/excalidraw/actions/shortcuts.d.ts +1 -1
  90. package/dist/types/excalidraw/actions/types.d.ts +8 -4
  91. package/dist/types/excalidraw/{animated-trail.d.ts → animatedTrail.d.ts} +4 -3
  92. package/dist/types/excalidraw/appState.d.ts +36 -12
  93. package/dist/types/excalidraw/charts/charts.bar.d.ts +2 -1
  94. package/dist/types/excalidraw/charts/charts.helpers.d.ts +6 -5
  95. package/dist/types/excalidraw/charts/charts.line.d.ts +2 -1
  96. package/dist/types/excalidraw/charts/charts.radar.d.ts +2 -1
  97. package/dist/types/excalidraw/charts/index.d.ts +2 -1
  98. package/dist/types/excalidraw/components/Actions.d.ts +17 -12
  99. package/dist/types/excalidraw/components/ActiveConfirmDialog.d.ts +1 -1
  100. package/dist/types/excalidraw/components/App.arrowText.d.ts +70 -0
  101. package/dist/types/excalidraw/components/App.bucketFill.d.ts +48 -0
  102. package/dist/types/excalidraw/components/App.clipboard.d.ts +31 -0
  103. package/dist/types/excalidraw/components/App.cursor.d.ts +38 -0
  104. package/dist/types/excalidraw/components/App.d.ts +332 -110
  105. package/dist/types/excalidraw/components/App.drawshape.d.ts +55 -0
  106. package/dist/types/excalidraw/components/App.duplicate.d.ts +101 -0
  107. package/dist/types/excalidraw/components/App.flowchart.d.ts +21 -0
  108. package/dist/types/excalidraw/components/App.host.d.ts +102 -0
  109. package/dist/types/excalidraw/components/App.modifiers.d.ts +38 -0
  110. package/dist/types/excalidraw/components/App.pan.d.ts +62 -0
  111. package/dist/types/excalidraw/components/App.selection.d.ts +265 -0
  112. package/dist/types/excalidraw/components/App.selectionTool.d.ts +93 -0
  113. package/dist/types/excalidraw/components/App.text.d.ts +146 -0
  114. package/dist/types/excalidraw/components/App.textTool.d.ts +140 -0
  115. package/dist/types/excalidraw/components/App.toolDrag.d.ts +63 -0
  116. package/dist/types/excalidraw/components/App.viewport.d.ts +123 -0
  117. package/dist/types/excalidraw/components/App.wheel.d.ts +26 -0
  118. package/dist/types/excalidraw/components/App.wrap.d.ts +31 -0
  119. package/dist/types/excalidraw/components/ColorPicker/ColorPicker.d.ts +9 -3
  120. package/dist/types/excalidraw/components/ColorPicker/CustomColorList.d.ts +3 -1
  121. package/dist/types/excalidraw/components/ColorPicker/Picker.d.ts +5 -1
  122. package/dist/types/excalidraw/components/ColorPicker/PickerColorList.d.ts +9 -2
  123. package/dist/types/excalidraw/components/ColorPicker/ShadeList.d.ts +4 -2
  124. package/dist/types/excalidraw/components/ColorPicker/TopPicks.d.ts +8 -1
  125. package/dist/types/excalidraw/components/ColorPicker/colorPickerUtils.d.ts +1 -1
  126. package/dist/types/excalidraw/components/ColorPicker/colorTopPicksDnD.d.ts +11 -0
  127. package/dist/types/excalidraw/components/ColorPicker/keyboardNavHandlers.d.ts +2 -1
  128. package/dist/types/excalidraw/components/CommandPalette/defaultCommandPaletteItems.d.ts +1 -2
  129. package/dist/types/excalidraw/components/ConvertElementTypePopup.d.ts +4 -3
  130. package/dist/types/excalidraw/components/CursorHint.d.ts +46 -0
  131. package/dist/types/excalidraw/components/EyeDropper.d.ts +1 -1
  132. package/dist/types/excalidraw/components/FileDropOverlay.d.ts +2 -0
  133. package/dist/types/excalidraw/components/FontPicker/FontPicker.d.ts +4 -1
  134. package/dist/types/excalidraw/components/FontPicker/FontPickerList.d.ts +6 -1
  135. package/dist/types/excalidraw/components/FontPicker/fontTopPicksDnD.d.ts +12 -0
  136. package/dist/types/excalidraw/components/IconButton.d.ts +48 -0
  137. package/dist/types/excalidraw/components/Island.d.ts +7 -0
  138. package/dist/types/excalidraw/components/LaserPointerButton.d.ts +2 -4
  139. package/dist/types/excalidraw/components/LayerUI.d.ts +5 -2
  140. package/dist/types/excalidraw/components/LibraryMenu.d.ts +1 -1
  141. package/dist/types/excalidraw/components/LibraryMenuSection.d.ts +6 -2
  142. package/dist/types/excalidraw/components/LibraryUnit.d.ts +7 -2
  143. package/dist/types/excalidraw/components/LockButton.d.ts +3 -4
  144. package/dist/types/excalidraw/components/MagicButton.d.ts +0 -2
  145. package/dist/types/excalidraw/components/MobileMenu.d.ts +4 -4
  146. package/dist/types/excalidraw/components/MobileToolbar.d.ts +9 -0
  147. package/dist/types/excalidraw/components/OverwriteConfirm/OverwriteConfirmState.d.ts +1 -1
  148. package/dist/types/excalidraw/components/PenModeButton.d.ts +2 -5
  149. package/dist/types/excalidraw/components/Popover.d.ts +1 -3
  150. package/dist/types/excalidraw/components/{ButtonIcon.d.ts → RadioButton.d.ts} +2 -5
  151. package/dist/types/excalidraw/components/SVGLayer.d.ts +1 -1
  152. package/dist/types/excalidraw/components/SearchMenu.d.ts +1 -1
  153. package/dist/types/excalidraw/components/Sidebar/Sidebar.d.ts +1 -1
  154. package/dist/types/excalidraw/components/Stats/Angle.d.ts +2 -2
  155. package/dist/types/excalidraw/components/Stats/Dimension.d.ts +2 -2
  156. package/dist/types/excalidraw/components/Stats/DragInput.d.ts +2 -2
  157. package/dist/types/excalidraw/components/Stats/MultiAngle.d.ts +2 -2
  158. package/dist/types/excalidraw/components/Stats/MultiDimension.d.ts +2 -2
  159. package/dist/types/excalidraw/components/Stats/MultiPosition.d.ts +2 -2
  160. package/dist/types/excalidraw/components/Stats/Position.d.ts +3 -3
  161. package/dist/types/excalidraw/components/Stats/utils.d.ts +4 -2
  162. package/dist/types/excalidraw/components/TTDDialog/MermaidToExcalidraw.d.ts +2 -1
  163. package/dist/types/excalidraw/components/TTDDialog/TTDContext.d.ts +4 -4
  164. package/dist/types/excalidraw/components/TTDDialog/TTDDialogOutput.d.ts +5 -2
  165. package/dist/types/excalidraw/components/TTDDialog/TTDPreviewPanel.d.ts +5 -2
  166. package/dist/types/excalidraw/components/TTDDialog/TextToDiagram.d.ts +2 -1
  167. package/dist/types/excalidraw/components/TTDDialog/common.d.ts +4 -1
  168. package/dist/types/excalidraw/components/TTDDialog/hooks/useTextGeneration.d.ts +3 -2
  169. package/dist/types/excalidraw/components/TTDDialog/types.d.ts +14 -1
  170. package/dist/types/excalidraw/components/TTDDialog/useTTDChatStorage.d.ts +3 -3
  171. package/dist/types/excalidraw/components/TTDDialog/utils/mermaidError.d.ts +27 -1
  172. package/dist/types/excalidraw/components/ToolPopover.d.ts +3 -6
  173. package/dist/types/excalidraw/components/Toolbar.d.ts +11 -0
  174. package/dist/types/excalidraw/components/Tools.d.ts +151 -0
  175. package/dist/types/excalidraw/components/Tooltip.d.ts +26 -2
  176. package/dist/types/excalidraw/components/TopPicksDnD/TopPicksContextMenu.d.ts +14 -0
  177. package/dist/types/excalidraw/components/TopPicksDnD/TopPicksTip.d.ts +11 -0
  178. package/dist/types/excalidraw/components/TopPicksDnD/topPicksDnD.d.ts +58 -0
  179. package/dist/types/excalidraw/components/UserList.d.ts +3 -2
  180. package/dist/types/excalidraw/components/ViewportStatusFrame/ViewportStatusFrame.d.ts +11 -0
  181. package/dist/types/excalidraw/components/canvases/InteractiveCanvas.d.ts +3 -2
  182. package/dist/types/excalidraw/components/canvases/NewElementCanvas.d.ts +3 -0
  183. package/dist/types/excalidraw/components/canvases/StaticCanvas.d.ts +1 -1
  184. package/dist/types/excalidraw/components/dropdownMenu/DropdownMenuItemContentRadio.d.ts +2 -1
  185. package/dist/types/excalidraw/components/footer/Footer.d.ts +3 -1
  186. package/dist/types/excalidraw/components/hyperlink/Hyperlink.d.ts +3 -2
  187. package/dist/types/excalidraw/components/hyperlink/helpers.d.ts +15 -4
  188. package/dist/types/excalidraw/components/icons.d.ts +7 -1
  189. package/dist/types/excalidraw/components/main-menu/DefaultItems.d.ts +10 -4
  190. package/dist/types/excalidraw/components/positionElementBesideCursor.d.ts +26 -0
  191. package/dist/types/excalidraw/components/shapeActionPredicates.d.ts +39 -0
  192. package/dist/types/excalidraw/data/blob.d.ts +74 -28
  193. package/dist/types/excalidraw/data/index.d.ts +7 -7
  194. package/dist/types/excalidraw/data/json.d.ts +43 -20
  195. package/dist/types/excalidraw/data/library.d.ts +1 -1
  196. package/dist/types/excalidraw/drawShapeTrail.d.ts +16 -0
  197. package/dist/types/excalidraw/eraser/index.d.ts +2 -3
  198. package/dist/types/excalidraw/fonts/Fonts.d.ts +12 -8
  199. package/dist/types/excalidraw/history.d.ts +10 -4
  200. package/dist/types/excalidraw/hooks/useAppStateValue.d.ts +29 -0
  201. package/dist/types/excalidraw/hooks/useLibraryItemSvg.d.ts +1 -1
  202. package/dist/types/excalidraw/hooks/useTextEditorFocus.d.ts +5 -5
  203. package/dist/types/excalidraw/{laser-trails.d.ts → laserTrails.d.ts} +5 -7
  204. package/dist/types/excalidraw/lasso/index.d.ts +2 -3
  205. package/dist/types/excalidraw/lasso/utils.d.ts +2 -0
  206. package/dist/types/excalidraw/reactUtils.d.ts +1 -1
  207. package/dist/types/excalidraw/renderOverrides.d.ts +9 -0
  208. package/dist/types/excalidraw/renderer/animation.d.ts +15 -4
  209. package/dist/types/excalidraw/renderer/helpers.d.ts +25 -0
  210. package/dist/types/excalidraw/renderer/interactiveScene.d.ts +2 -4
  211. package/dist/types/excalidraw/renderer/staticScene.d.ts +11 -6
  212. package/dist/types/excalidraw/scene/Renderer.d.ts +490 -21
  213. package/dist/types/excalidraw/scene/export.d.ts +344 -21
  214. package/dist/types/excalidraw/scene/index.d.ts +2 -2
  215. package/dist/types/excalidraw/scene/types.d.ts +30 -5
  216. package/dist/types/excalidraw/snapping.d.ts +7 -7
  217. package/dist/types/excalidraw/types.d.ts +579 -29
  218. package/dist/types/excalidraw/viewport.d.ts +302 -0
  219. package/dist/types/excalidraw/wysiwyg/textWysiwyg.d.ts +13 -3
  220. package/dist/types/fractional-indexing/src/index.d.ts +29 -0
  221. package/dist/types/laser-pointer/src/index.d.ts +2 -0
  222. package/dist/types/laser-pointer/src/math.d.ts +16 -0
  223. package/dist/types/laser-pointer/src/simplify.d.ts +2 -0
  224. package/dist/types/laser-pointer/src/state.d.ts +36 -0
  225. package/dist/types/math/src/constants.d.ts +0 -1
  226. package/dist/types/math/src/curve.d.ts +23 -13
  227. package/dist/types/math/src/index.d.ts +1 -0
  228. package/dist/types/math/src/pca.d.ts +79 -0
  229. package/dist/types/math/src/point.d.ts +1 -0
  230. package/dist/types/math/src/polygon.d.ts +25 -1
  231. package/dist/types/math/src/segment.d.ts +6 -0
  232. package/dist/types/utils/src/index.d.ts +4 -3
  233. package/dist/types/utils/src/shape.d.ts +2 -2
  234. package/package.json +2 -2
  235. package/dist/types/excalidraw/animation-frame-handler.d.ts +0 -16
  236. package/dist/types/excalidraw/components/FollowMode/FollowMode.d.ts +0 -10
  237. package/dist/types/excalidraw/components/HandButton.d.ts +0 -10
  238. package/dist/types/excalidraw/components/MobileToolBar.d.ts +0 -10
  239. package/dist/types/excalidraw/components/ToolButton.d.ts +0 -49
  240. package/dist/types/excalidraw/components/shapes.d.ts +0 -263
  241. package/dist/types/excalidraw/cursor.d.ts +0 -5
  242. package/dist/types/excalidraw/scene/scroll.d.ts +0 -18
  243. package/dist/types/excalidraw/scene/zoom.d.ts +0 -12
  244. package/dist/types/utils/src/bbox.d.ts +0 -9
  245. package/dist/types/utils/src/export.d.ts +0 -35
  246. package/dist/types/utils/src/withinBounds.d.ts +0 -19
@@ -1,31 +1,299 @@
1
- import type { ExcalidrawFrameLikeElement, NonDeletedExcalidrawElement } from "@excalidraw/element/types";
1
+ import { MIME_TYPES } from "@excalidraw/common";
2
+ import type { RenderEnvironment } from "@excalidraw/element";
3
+ import type { ExcalidrawFrameLikeElement, NonDeleted, NonDeletedExcalidrawElement, Theme } from "@excalidraw/element/types";
4
+ import { cleanAppStateForExport } from "../appState";
2
5
  import type { AppState, BinaryFiles } from "../types";
3
- export declare const exportToCanvas: (elements: readonly NonDeletedExcalidrawElement[], appState: AppState, files: BinaryFiles, { exportBackground, exportPadding, viewBackgroundColor, exportingFrame, }: {
4
- exportBackground: boolean;
5
- exportPadding?: number;
6
- viewBackgroundColor: string;
7
- exportingFrame?: ExcalidrawFrameLikeElement | null;
8
- }, createCanvas?: (width: number, height: number) => {
9
- canvas: HTMLCanvasElement;
6
+ export type ExportSceneData = {
7
+ elements: readonly NonDeletedExcalidrawElement[];
8
+ /**
9
+ * The scene settings a `.excalidraw` file stores (`viewBackgroundColor`,
10
+ * grid settings) — not editor state. Used as the default background
11
+ * (`canvasBackgroundColor`) and embedded with the scene (`embedScene`).
12
+ * Anything else passed in is ignored; rendering options go to `config`.
13
+ */
14
+ appState?: ReturnType<typeof cleanAppStateForExport>;
15
+ files?: BinaryFiles | null;
16
+ };
17
+ /**
18
+ * The host capabilities an export uses, shared by every format: e.g. for test
19
+ * environments, Node.js or another window.
20
+ *
21
+ * Unlike the editor's `renderEnvironment` prop, this needn't be the same
22
+ * object across exports (e.g. on a server): exports draw without the element
23
+ * caches keyed by an environment, and measure little text. Passing a complete
24
+ * one (`createCanvas` and `createImage`) as-is, as the editor does, only keeps
25
+ * its measuring caches warm.
26
+ */
27
+ type ExportEnvironment = {
28
+ /**
29
+ * Creates the canvas a canvas/PNG/JPEG export renders into, and any canvas
30
+ * the export measures text with (e.g. frame labels, embed placeholders).
31
+ *
32
+ * Do not set `canvas.width/height` or modify the canvas context as that's
33
+ * handled by Excalidraw.
34
+ *
35
+ * Defaults to `document.createElement("canvas")`.
36
+ */
37
+ createCanvas?: RenderEnvironment["createCanvas"];
38
+ /**
39
+ * Creates the images that image elements are decoded into.
40
+ *
41
+ * Defaults to `new Image()`.
42
+ */
43
+ createImage?: RenderEnvironment["createImage"];
44
+ /**
45
+ * Creates the paths that freedraw elements are filled through.
46
+ *
47
+ * Defaults to the global `Path2D`.
48
+ */
49
+ createPath?: RenderEnvironment["createPath"];
50
+ /**
51
+ * The document an SVG export is built in, e.g. a popout window's or,
52
+ * outside the browser, a DOM implementation's (such as `linkedom`).
53
+ *
54
+ * Defaults to the global `document`.
55
+ */
56
+ document?: RenderEnvironment["document"];
57
+ /**
58
+ * Measures text (frame labels, embed placeholders), e.g. where there is no
59
+ * canvas to measure on.
60
+ *
61
+ * Defaults to the global provider set with `setCustomTextMetricsProvider`,
62
+ * else to measuring on a canvas from `createCanvas`.
63
+ */
64
+ textMetrics?: RenderEnvironment["textMetrics"];
65
+ /**
66
+ * Loads the fonts the exported elements use, before rendering.
67
+ *
68
+ * Defaults to loading them through the browser's
69
+ * [FontFace API](https://developer.mozilla.org/en-US/docs/Web/API/FontFace).
70
+ */
71
+ loadFonts?: () => Promise<void>;
72
+ };
73
+ type ExportSceneBaseConfig = {
74
+ /**
75
+ * @default "light"
76
+ */
77
+ theme?: Theme;
78
+ /**
79
+ * Canvas background. Valid values are:
80
+ *
81
+ * - `undefined` - the background of "appState.viewBackgroundColor" is used.
82
+ * - `false` - no background is used (transparent). Not supported for JPEG,
83
+ * which falls back to the default.
84
+ * - `string` - should be a valid CSS color.
85
+ *
86
+ * Specified in light-theme terms: `theme: "dark"` transforms it like any
87
+ * other scene color. Only affects the rendered image, not the embedded
88
+ * scene (`embedScene`).
89
+ *
90
+ * @default undefined
91
+ */
92
+ canvasBackgroundColor?: string | false;
93
+ /**
94
+ * Canvas padding in pixels. Affected by `scale`.
95
+ *
96
+ * When `fit` is `none`, padding is added around the content bounding box,
97
+ * or around the `width`/`height` frame if set — in which case the content
98
+ * may overflow the frame, thus right or bottom padding may be ignored.
99
+ *
100
+ * When `fit` is `contain`, or `maxWidthOrHeight`/`widthOrHeight` is set,
101
+ * padding is subtracted from the target size (so the export doesn't exceed
102
+ * it, `scale` aside), and serves as a minimum distance between the content
103
+ * and the canvas edges — it may be exceeded on one axis to maintain the
104
+ * aspect ratio. It is recommended to set `position` to `center` when using
105
+ * `fit: "contain"`.
106
+ *
107
+ * @default 10
108
+ */
109
+ padding?: number;
110
+ /**
111
+ * A multiplier to increase/decrease the frame dimensions
112
+ * (content resolution).
113
+ *
114
+ * For example, if your canvas is 300x150 and you set scale to 2, the
115
+ * resulting size will be 600x300.
116
+ *
117
+ * Can be a function, which receives the export dimensions at scale 1
118
+ * (padding included) and returns the multiplier — e.g. to cap the output
119
+ * by a pixel budget.
120
+ *
121
+ * @default 1
122
+ */
123
+ scale?: number | ((width: number, height: number) => number);
124
+ /**
125
+ * Host environment overrides, e.g. for test environments or Node.js.
126
+ */
127
+ environment?: ExportEnvironment;
128
+ exportingFrame?: NonDeleted<ExcalidrawFrameLikeElement> | null;
129
+ /**
130
+ * Which frame decorations to render. Ignored when exporting a single frame
131
+ * (`exportingFrame`), which renders neither its name nor outline, and clips
132
+ * to it.
133
+ *
134
+ * @default { name: true, outline: true, clip: true }
135
+ */
136
+ frames?: {
137
+ name?: boolean;
138
+ outline?: boolean;
139
+ clip?: boolean;
140
+ };
141
+ };
142
+ /**
143
+ * The ways to size the export — only one can be used. The positioning options
144
+ * (`fit`, `position`, `x`, `y`, `origin`) belong to `width`/`height` (or no
145
+ * size option).
146
+ */
147
+ type ExportSizeOptions = {
148
+ /**
149
+ * Makes sure the canvas content fits into a frame of width/height no larger
150
+ * than this value, while maintaining the aspect ratio.
151
+ *
152
+ * Final dimensions can get smaller/larger if used in conjunction with
153
+ * `scale`.
154
+ *
155
+ * Can't be combined with `width`/`height`, `widthOrHeight`, or the
156
+ * positioning options (`fit`, `position`, `x`, `y`, `origin`).
157
+ */
158
+ maxWidthOrHeight?: number;
159
+ /**
160
+ * Scale the canvas content to be exactly this many pixels wide/tall,
161
+ * maintaining the aspect ratio.
162
+ *
163
+ * Final dimensions can get smaller/larger if used in conjunction with
164
+ * `scale`.
165
+ *
166
+ * Can't be combined with `width`/`height`, `maxWidthOrHeight`, or the
167
+ * positioning options (`fit`, `position`, `x`, `y`, `origin`).
168
+ */
169
+ widthOrHeight?: number;
170
+ /**
171
+ * Width of the frame. Supply `x` or `y` if you want to offset the canvas
172
+ * content.
173
+ *
174
+ * If `width` omitted but `height` supplied, `width` is calculated from the
175
+ * content's aspect ratio when `fit` is `contain` (the default), or is the
176
+ * content bounding box width when `fit` is `none`.
177
+ *
178
+ * Defaults to the content bounding box width when both `width` and `height`
179
+ * are omitted.
180
+ *
181
+ * Can't be combined with `maxWidthOrHeight` or `widthOrHeight`.
182
+ */
183
+ width?: number;
184
+ /**
185
+ * Height of the frame.
186
+ *
187
+ * If `height` omitted but `width` supplied, `height` is calculated from the
188
+ * content's aspect ratio when `fit` is `contain` (the default), or is the
189
+ * content bounding box height when `fit` is `none`.
190
+ *
191
+ * Defaults to the content bounding box height when both `width` and `height`
192
+ * are omitted.
193
+ *
194
+ * Can't be combined with `maxWidthOrHeight` or `widthOrHeight`.
195
+ */
196
+ height?: number;
197
+ /**
198
+ * Left edge of the exported region (`padding` is added around it). By
199
+ * default the coordinate is relative to the canvas. You can switch to
200
+ * content coordinates by setting `origin` to `content`.
201
+ *
202
+ * Defaults to the `x` position of the content bounding box.
203
+ *
204
+ * Can't be combined with `maxWidthOrHeight` or `widthOrHeight`, and is
205
+ * ignored with `fit: "contain"`, so setting `x` or `y` makes `fit` default
206
+ * to `none` (cropping the region).
207
+ */
208
+ x?: number;
209
+ /**
210
+ * Top edge of the exported region (`padding` is added around it). By
211
+ * default the coordinate is relative to the canvas. You can switch to
212
+ * content coordinates by setting `origin` to `content`.
213
+ *
214
+ * Defaults to the `y` position of the content bounding box.
215
+ *
216
+ * Can't be combined with `maxWidthOrHeight` or `widthOrHeight`, and is
217
+ * ignored with `fit: "contain"`, so setting `x` or `y` makes `fit` default
218
+ * to `none` (cropping the region).
219
+ */
220
+ y?: number;
221
+ /**
222
+ * Indicates the coordinate system of the `x` and `y` values.
223
+ *
224
+ * - `canvas` - `x` and `y` are relative to the canvas [0, 0] position.
225
+ * - `content` - `x` and `y` are relative to the content bounding box.
226
+ *
227
+ * Can't be combined with `maxWidthOrHeight` or `widthOrHeight`.
228
+ *
229
+ * @default "canvas"
230
+ */
231
+ origin?: "canvas" | "content";
232
+ /**
233
+ * How the content should be scaled into the `width`/`height` frame.
234
+ *
235
+ * Behavior aligns with the `object-fit` CSS property.
236
+ *
237
+ * - `none` - no scaling.
238
+ * - `contain` - scale to fit the frame. Includes `padding`.
239
+ *
240
+ * Can't be combined with `maxWidthOrHeight` or `widthOrHeight`.
241
+ *
242
+ * @default "contain" if `width` or `height` is set (and `x`/`y` aren't),
243
+ * otherwise "none"
244
+ */
245
+ fit?: "none" | "contain";
246
+ /**
247
+ * When either `x` or `y` are not specified, indicates how the canvas should
248
+ * be aligned on the respective axis.
249
+ *
250
+ * - `topLeft` - canvas aligned to top left.
251
+ * - `center` - canvas is centered on the axis which is not specified
252
+ * (or both).
253
+ *
254
+ * Can't be combined with `maxWidthOrHeight` or `widthOrHeight`.
255
+ *
256
+ * @default "center"
257
+ */
258
+ position?: "center" | "topLeft";
259
+ };
260
+ type ExportSizeOption<K extends keyof ExportSizeOptions> = Pick<ExportSizeOptions, K> & {
261
+ [P in keyof ExportSizeOptions as P extends K ? never : P]?: never;
262
+ };
263
+ type ExportSizeConfig = ExportSizeOption<"width" | "height" | "fit" | "position" | "x" | "y" | "origin"> | ExportSizeOption<"maxWidthOrHeight"> | ExportSizeOption<"widthOrHeight">;
264
+ export type ExportSceneConfig = ExportSceneBaseConfig & ExportSizeConfig;
265
+ /**
266
+ * The export config the editor's export settings translate to. Internal: hosts
267
+ * pass their own config.
268
+ */
269
+ export declare const getExportConfigFromAppState: (appState: Pick<AppState, "exportWithDarkMode" | "exportBackground" | "viewBackgroundColor" | "exportScale" | "frameRendering">) => {
270
+ theme: "light" | "dark";
271
+ canvasBackgroundColor: string | false;
10
272
  scale: number;
11
- }, loadFonts?: () => Promise<void>) => Promise<HTMLCanvasElement>;
12
- export declare const exportToSvg: (elements: readonly NonDeletedExcalidrawElement[], appState: {
13
- exportBackground: boolean;
14
- exportPadding?: number;
15
- exportScale?: number;
16
- viewBackgroundColor: string;
17
- exportWithDarkMode?: boolean;
18
- exportEmbedScene?: boolean;
19
- frameRendering?: AppState["frameRendering"];
20
- }, files: BinaryFiles | null, opts?: {
273
+ frames: {
274
+ enabled: boolean;
275
+ name: boolean;
276
+ outline: boolean;
277
+ clip: boolean;
278
+ } | {
279
+ name: boolean;
280
+ outline: boolean;
281
+ clip: boolean;
282
+ };
283
+ };
284
+ type ExportToSvgConfig = Pick<ExportSceneBaseConfig, "canvasBackgroundColor" | "padding" | "theme" | "exportingFrame" | "scale" | "frames" | "environment"> & ExportSizeConfig & {
21
285
  /**
22
286
  * if true, all embeddables passed in will be rendered when possible.
23
287
  */
24
288
  renderEmbeddables?: boolean;
25
- exportingFrame?: ExcalidrawFrameLikeElement | null;
26
289
  skipInliningFonts?: true;
27
290
  reuseImages?: boolean;
28
- }) => Promise<SVGSVGElement>;
291
+ /**
292
+ * Embeds the scene into the SVG, so that it can be imported back into
293
+ * Excalidraw.
294
+ */
295
+ embedScene?: boolean;
296
+ };
29
297
  export declare const encodeSvgBase64Payload: ({ payload, metadataElement, }: {
30
298
  payload: string;
31
299
  metadataElement: SVGMetadataElement;
@@ -33,4 +301,59 @@ export declare const encodeSvgBase64Payload: ({ payload, metadataElement, }: {
33
301
  export declare const decodeSvgBase64Payload: ({ svg }: {
34
302
  svg: string;
35
303
  }) => string;
36
- export declare const getExportSize: (elements: readonly NonDeletedExcalidrawElement[], exportPadding: number, scale: number) => [number, number];
304
+ export { MIME_TYPES };
305
+ type ExportToPngConfig = ExportSceneConfig & {
306
+ /**
307
+ * Embeds the scene into the PNG metadata, so that it can be imported back
308
+ * into Excalidraw.
309
+ */
310
+ embedScene?: boolean;
311
+ };
312
+ type ExportToJpegConfig = ExportSceneConfig & {
313
+ /**
314
+ * Encoding quality between 0 and 1.
315
+ *
316
+ * @default 0.92
317
+ */
318
+ quality?: number;
319
+ };
320
+ export type ExportSceneOptions = {
321
+ data: ExportSceneData;
322
+ } & ({
323
+ type: "canvas";
324
+ config?: ExportSceneConfig;
325
+ } | {
326
+ type: "png";
327
+ config?: ExportToPngConfig;
328
+ } | {
329
+ type: "jpeg";
330
+ config?: ExportToJpegConfig;
331
+ } | {
332
+ type: "svg";
333
+ config?: ExportToSvgConfig;
334
+ });
335
+ /**
336
+ * Exports the scene to a canvas, a PNG or JPEG blob, or an SVG element.
337
+ */
338
+ export declare function exportScene(opts: Extract<ExportSceneOptions, {
339
+ type: "canvas";
340
+ }>): Promise<HTMLCanvasElement>;
341
+ export declare function exportScene(opts: Extract<ExportSceneOptions, {
342
+ type: "png" | "jpeg";
343
+ }>): Promise<Blob>;
344
+ export declare function exportScene(opts: Extract<ExportSceneOptions, {
345
+ type: "svg";
346
+ }>): Promise<SVGSVGElement>;
347
+ export declare function exportScene(opts: ExportSceneOptions): Promise<HTMLCanvasElement | Blob | SVGSVGElement>;
348
+ export declare const exportToClipboard: (opts: {
349
+ data: ExportSceneData;
350
+ } & ({
351
+ type: "png";
352
+ config?: ExportToPngConfig;
353
+ } | {
354
+ type: "svg";
355
+ config?: ExportToSvgConfig;
356
+ } | {
357
+ type: "json";
358
+ config?: never;
359
+ })) => Promise<void>;
@@ -1,4 +1,4 @@
1
1
  export { isSomeElementSelected, getElementsWithinSelection, getSelectedElements, getTargetElements, } from "@excalidraw/element";
2
- export { calculateScrollCenter } from "./scroll";
3
- export { hasBackground, hasStrokeWidth, hasStrokeStyle, canHaveArrowheads, canChangeRoundness, } from "@excalidraw/element";
2
+ export { getScrollToContentState } from "../viewport";
3
+ export { hasBackground, hasFillStyle, hasRoughness, hasStrokeWidth, hasStrokeStyle, hasFreedrawMode, canHaveArrowheads, canChangeRoundness, } from "@excalidraw/element";
4
4
  export { getNormalizedZoom, getNormalizedGridSize, getNormalizedGridStep, } from "./normalize";
@@ -1,14 +1,33 @@
1
1
  import type { UserIdleState, EditorInterface } from "@excalidraw/common";
2
- import type { ExcalidrawElement, NonDeletedElementsMap, NonDeletedExcalidrawElement, NonDeletedSceneElementsMap } from "@excalidraw/element/types";
2
+ import type { ExcalidrawElement, ExcalidrawFrameLikeElement, NonDeletedElementsMap, NonDeletedExcalidrawElement, NonDeletedSceneElementsMap } from "@excalidraw/element/types";
3
3
  import type { MakeBrand } from "@excalidraw/common/utility-types";
4
- import type { AppClassProperties, AppState, EmbedsValidationStatus, ElementsPendingErasure, InteractiveCanvasAppState, StaticCanvasAppState, SocketId, PendingExcalidrawElements } from "../types";
4
+ import type { RenderEnvironment } from "@excalidraw/element/renderEnvironment";
5
+ import type { AppClassProperties, AppState, EmbedsValidationStatus, ElementRenderOverrides, ElementsPendingErasure, InteractiveCanvasAppState, StaticCanvasAppState, SocketId, PendingExcalidrawElements } from "../types";
5
6
  import type { RoughCanvas } from "roughjs/bin/canvas";
6
7
  import type { Drawable } from "roughjs/bin/core";
7
8
  export type RenderableElementsMap = NonDeletedElementsMap & MakeBrand<"RenderableElementsMap">;
8
9
  export type StaticCanvasRenderConfig = {
9
10
  canvasBackgroundColor: AppState["viewBackgroundColor"];
11
+ /**
12
+ * Backing-store scale the target canvas was bootstrapped with -- the owner
13
+ * window's devicePixelRatio when rendering into the editor, exportScale when
14
+ * exporting. Element caches are built and blitted at this ratio, so it must
15
+ * be the same value passed as `StaticSceneRenderConfig["scale"]`.
16
+ */
17
+ scale: number;
18
+ /**
19
+ * Host environment that creates the canvases and images this render
20
+ * rasterizes (per-editor owner window in the app; the export's
21
+ * `config.environment` when exporting). Defaults to the browser's.
22
+ */
23
+ renderEnvironment?: RenderEnvironment;
24
+ /** export only: clips everything drawn to this frame (square corners) */
25
+ clipToFrame?: ExcalidrawFrameLikeElement | null;
10
26
  imageCache: AppClassProperties["imageCache"];
11
27
  renderGrid: boolean;
28
+ /** whether to render link icons on elements with links (never rendered
29
+ when exporting). @default true */
30
+ renderLinks?: boolean;
12
31
  /** when exporting the behavior is slightly different (e.g. we can't use
13
32
  CSS filters), and we disable render optimizations for best output */
14
33
  isExporting: boolean;
@@ -16,8 +35,15 @@ export type StaticCanvasRenderConfig = {
16
35
  elementsPendingErasure: ElementsPendingErasure;
17
36
  pendingFlowchartNodes: PendingExcalidrawElements | null;
18
37
  theme: AppState["theme"];
38
+ elementRenderOverrides?: ElementRenderOverrides;
19
39
  };
20
40
  export type SVGRenderConfig = {
41
+ /**
42
+ * Host environment used for the text measurements this render needs (the
43
+ * SVG itself is built through `exportToSvg`'s owner document). Defaults to
44
+ * the browser's.
45
+ */
46
+ renderEnvironment?: RenderEnvironment;
21
47
  offsetX: number;
22
48
  offsetY: number;
23
49
  isExporting: boolean;
@@ -52,8 +78,6 @@ export type InteractiveCanvasRenderConfig = {
52
78
  renderScrollbars?: boolean;
53
79
  };
54
80
  export type RenderInteractiveSceneCallback = {
55
- atLeastOneVisibleElement: boolean;
56
- elementsMap: RenderableElementsMap;
57
81
  scrollBars?: ScrollBars;
58
82
  };
59
83
  export type StaticSceneRenderConfig = {
@@ -89,7 +113,7 @@ export type InteractiveSceneRenderConfig = {
89
113
  export type NewElementSceneRenderConfig = {
90
114
  canvas: HTMLCanvasElement | null;
91
115
  rc: RoughCanvas;
92
- newElement: ExcalidrawElement | null;
116
+ newElement: NonDeletedExcalidrawElement | null;
93
117
  elementsMap: RenderableElementsMap;
94
118
  allElementsMap: NonDeletedSceneElementsMap;
95
119
  scale: number;
@@ -131,6 +155,7 @@ export type ElementShapes = {
131
155
  arrow: Drawable[];
132
156
  line: Drawable[];
133
157
  text: null;
158
+ stickynote: null;
134
159
  image: null;
135
160
  frame: null;
136
161
  magicframe: null;
@@ -66,19 +66,19 @@ export declare const isGridModeEnabled: (app: AppClassProperties) => boolean;
66
66
  export declare const isSnappingEnabled: ({ event, app, selectedElements, }: {
67
67
  app: AppClassProperties;
68
68
  event: KeyboardModifiersObject;
69
- selectedElements: NonDeletedExcalidrawElement[];
69
+ selectedElements: readonly NonDeletedExcalidrawElement[];
70
70
  }) => boolean;
71
71
  export declare const areRoughlyEqual: (a: number, b: number, precision?: number) => boolean;
72
- export declare const getElementsCorners: (elements: ExcalidrawElement[], elementsMap: ElementsMap, { omitCenter, boundingBoxCorners, dragOffset, }?: {
72
+ export declare const getElementsCorners: (elements: readonly NonDeletedExcalidrawElement[], elementsMap: ElementsMap, { omitCenter, boundingBoxCorners, dragOffset, }?: {
73
73
  omitCenter?: boolean;
74
74
  boundingBoxCorners?: boolean;
75
75
  dragOffset?: Vector2D;
76
76
  }) => GlobalPoint[];
77
- export declare const getVisibleGaps: (elements: readonly NonDeletedExcalidrawElement[], selectedElements: ExcalidrawElement[], appState: AppState, elementsMap: ElementsMap) => {
77
+ export declare const getVisibleGaps: (elements: readonly NonDeletedExcalidrawElement[], selectedElements: readonly NonDeletedExcalidrawElement[], appState: AppState, elementsMap: ElementsMap) => {
78
78
  horizontalGaps: Gap[];
79
79
  verticalGaps: Gap[];
80
80
  };
81
- export declare const getReferenceSnapPoints: (elements: readonly NonDeletedExcalidrawElement[], selectedElements: ExcalidrawElement[], appState: AppState, elementsMap: ElementsMap) => GlobalPoint[];
81
+ export declare const getReferenceSnapPoints: (elements: readonly NonDeletedExcalidrawElement[], selectedElements: readonly NonDeletedExcalidrawElement[], appState: AppState, elementsMap: ElementsMap) => GlobalPoint[];
82
82
  export declare const snapDraggedElements: (elements: ExcalidrawElement[], dragOffset: Vector2D, app: AppClassProperties, event: KeyboardModifiersObject, elementsMap: ElementsMap) => {
83
83
  snapOffset: {
84
84
  x: number;
@@ -86,21 +86,21 @@ export declare const snapDraggedElements: (elements: ExcalidrawElement[], dragOf
86
86
  };
87
87
  snapLines: (PointSnapLine | GapSnapLine)[];
88
88
  };
89
- export declare const snapResizingElements: (selectedElements: ExcalidrawElement[], selectedOriginalElements: ExcalidrawElement[], app: AppClassProperties, event: KeyboardModifiersObject, dragOffset: Vector2D, transformHandle: MaybeTransformHandleType) => {
89
+ export declare const snapResizingElements: (selectedElements: readonly NonDeletedExcalidrawElement[], selectedOriginalElements: readonly NonDeletedExcalidrawElement[], app: AppClassProperties, event: KeyboardModifiersObject, dragOffset: Vector2D, transformHandle: MaybeTransformHandleType) => {
90
90
  snapOffset: {
91
91
  x: number;
92
92
  y: number;
93
93
  };
94
94
  snapLines: PointSnapLine[];
95
95
  };
96
- export declare const snapNewElement: (newElement: ExcalidrawElement, app: AppClassProperties, event: KeyboardModifiersObject, origin: Vector2D, dragOffset: Vector2D, elementsMap: ElementsMap) => {
96
+ export declare const snapNewElement: (newElement: NonDeletedExcalidrawElement, app: AppClassProperties, event: KeyboardModifiersObject, origin: Vector2D, dragOffset: Vector2D, elementsMap: ElementsMap) => {
97
97
  snapOffset: {
98
98
  x: number;
99
99
  y: number;
100
100
  };
101
101
  snapLines: PointSnapLine[];
102
102
  };
103
- export declare const getSnapLinesAtPointer: (elements: readonly ExcalidrawElement[], app: AppClassProperties, pointer: Vector2D, event: KeyboardModifiersObject, elementsMap: ElementsMap) => {
103
+ export declare const getSnapLinesAtPointer: (elements: readonly NonDeletedExcalidrawElement[], app: AppClassProperties, pointer: Vector2D, event: KeyboardModifiersObject, elementsMap: ElementsMap) => {
104
104
  originOffset: {
105
105
  x: number;
106
106
  y: number;