@excalidraw/math
Version:
Excalidraw math functions
569 lines (568 loc) • 25.8 kB
TypeScript
/// <reference types="react" />
import { LinearElementEditor } from "@excalidraw/element";
import type { ExcalidrawElement } from "@excalidraw/element/types";
import type { AppClassProperties, AppState } from "../types";
export declare const actionDeleteSelected: {
name: "deleteSelectedElements";
label: string;
icon: import("react/jsx-runtime").JSX.Element;
trackEvent: {
category: "element";
action: string;
};
perform: (elements: readonly import("@excalidraw/element/types").OrderedExcalidrawElement[], appState: Readonly<AppState>, formData: any, app: AppClassProperties) => false | {
elements: import("@excalidraw/element/types").OrderedExcalidrawElement[];
appState: {
editingLinearElement: null;
contextMenu: {
items: import("../components/ContextMenu").ContextMenuItems;
top: number;
left: number;
} | null;
showWelcomeScreen: boolean;
isLoading: boolean;
errorMessage: import("react").ReactNode;
activeEmbeddable: {
element: import("@excalidraw/element/types").NonDeletedExcalidrawElement;
state: "active" | "hover";
} | null;
newElement: import("@excalidraw/element/types").NonDeleted<import("@excalidraw/element/types").ExcalidrawNonSelectionElement> | null;
resizingElement: import("@excalidraw/element/types").NonDeletedExcalidrawElement | null;
multiElement: import("@excalidraw/element/types").NonDeleted<import("@excalidraw/element/types").ExcalidrawLinearElement> | null;
selectionElement: import("@excalidraw/element/types").NonDeletedExcalidrawElement | null;
isBindingEnabled: boolean;
startBoundElement: import("@excalidraw/element/types").NonDeleted<import("@excalidraw/element/types").ExcalidrawBindableElement> | null;
suggestedBindings: import("@excalidraw/element").SuggestedBinding[];
frameToHighlight: import("@excalidraw/element/types").NonDeleted<import("@excalidraw/element/types").ExcalidrawFrameLikeElement> | null;
frameRendering: {
enabled: boolean;
name: boolean;
outline: boolean;
clip: boolean;
};
editingFrame: string | null;
elementsToHighlight: import("@excalidraw/element/types").NonDeleted<ExcalidrawElement>[] | null;
editingTextElement: import("@excalidraw/element/types").NonDeletedExcalidrawElement | null;
activeTool: {
lastActiveTool: import("../types").ActiveTool | null;
locked: boolean;
fromSelection: boolean;
} & import("../types").ActiveTool;
penMode: boolean;
penDetected: boolean;
exportBackground: boolean;
exportEmbedScene: boolean;
exportWithDarkMode: boolean;
exportScale: number;
currentItemStrokeColor: string;
currentItemBackgroundColor: string;
currentItemFillStyle: import("@excalidraw/element/types").FillStyle;
currentItemStrokeWidth: number;
currentItemStrokeStyle: import("@excalidraw/element/types").StrokeStyle;
currentItemRoughness: number;
currentItemOpacity: number;
currentItemFontFamily: number;
currentItemFontSize: number;
currentItemTextAlign: string;
currentItemStartArrowhead: import("@excalidraw/element/types").Arrowhead | null;
currentItemEndArrowhead: import("@excalidraw/element/types").Arrowhead | null;
currentHoveredFontFamily: number | null;
currentItemRoundness: import("@excalidraw/element/types").StrokeRoundness;
currentItemArrowType: "round" | "sharp" | "elbow";
viewBackgroundColor: string;
scrollX: number;
scrollY: number;
cursorButton: "up" | "down";
scrolledOutside: boolean;
name: string | null;
isResizing: boolean;
isRotating: boolean;
zoom: Readonly<{
value: import("../types").NormalizedZoomValue;
}>;
openMenu: "canvas" | "shape" | null;
openPopup: "fontFamily" | "canvasBackground" | "elementBackground" | "elementStroke" | null;
openSidebar: {
name: string;
tab?: string | undefined;
} | null;
openDialog: {
name: "imageExport" | "help" | "jsonExport";
} | {
name: "ttd";
tab: "mermaid" | "text-to-diagram";
} | {
name: "commandPalette";
} | {
name: "elementLinkSelector";
sourceElementId: string;
} | null;
defaultSidebarDockedPreference: boolean;
lastPointerDownWith: import("@excalidraw/element/types").PointerType;
selectedElementIds: Readonly<{
[id: string]: true;
}>;
hoveredElementIds: Readonly<{
[id: string]: true;
}>;
previousSelectedElementIds: {
[id: string]: true;
};
selectedElementsAreBeingDragged: boolean;
shouldCacheIgnoreZoom: boolean;
toast: {
message: string;
closable?: boolean | undefined;
duration?: number | undefined;
} | null;
zenModeEnabled: boolean;
theme: import("@excalidraw/element/types").Theme;
gridSize: number;
gridStep: number;
gridModeEnabled: boolean;
viewModeEnabled: boolean;
selectedGroupIds: {
[groupId: string]: boolean;
};
editingGroupId: string | null;
width: number;
height: number;
offsetTop: number;
offsetLeft: number;
fileHandle: import("browser-fs-access").FileSystemHandle | null;
collaborators: Map<import("../types").SocketId, Readonly<{
pointer?: import("../types").CollaboratorPointer | undefined;
button?: "up" | "down" | undefined;
selectedElementIds?: Readonly<{
[id: string]: true;
}> | undefined;
username?: string | null | undefined;
userState?: import("@excalidraw/common").UserIdleState | undefined;
color?: {
background: string;
stroke: string;
} | undefined;
avatarUrl?: string | undefined;
id?: string | undefined;
socketId?: import("../types").SocketId | undefined;
isCurrentUser?: boolean | undefined;
isInCall?: boolean | undefined;
isSpeaking?: boolean | undefined;
isMuted?: boolean | undefined;
}>>;
stats: {
open: boolean;
panels: number;
};
currentChartType: import("@excalidraw/element/types").ChartType;
pasteDialog: {
shown: false;
data: null;
} | {
shown: true;
data: import("../charts").Spreadsheet;
};
showHyperlinkPopup: false | "editor" | "info";
selectedLinearElement: LinearElementEditor | null;
snapLines: readonly import("../snapping").SnapLine[];
originSnapOffset: {
x: number;
y: number;
} | null;
objectsSnapModeEnabled: boolean;
userToFollow: import("../types").UserToFollow | null;
followedBy: Set<import("../types").SocketId>;
isCropping: boolean;
croppingElementId: string | null;
searchMatches: Readonly<{
focusedId: string | null;
matches: readonly import("../types").SearchMatch[];
}> | null;
activeLockedId: string | null;
lockedMultiSelections: {
[groupId: string]: true;
};
};
captureUpdate: "IMMEDIATELY";
} | {
elements: readonly import("@excalidraw/element/types").OrderedExcalidrawElement[];
appState: {
editingLinearElement: {
selectedPointsIndices: number[];
startBindingElement: import("@excalidraw/element/types").ExcalidrawBindableElement | "keep" | null;
endBindingElement: import("@excalidraw/element/types").ExcalidrawBindableElement | "keep" | null;
elementId: string & {
_brand: "excalidrawLinearElementId";
};
pointerDownState: Readonly<{
prevSelectedPointsIndices: readonly number[] | null;
lastClickedPoint: number;
lastClickedIsEndPoint: boolean;
origin: Readonly<{
x: number;
y: number;
}> | null;
segmentMidpoint: {
value: import("@excalidraw/math").GlobalPoint | null;
index: number | null;
added: boolean;
};
}>;
isDragging: boolean;
lastUncommittedPoint: import("@excalidraw/math").LocalPoint | null;
pointerOffset: Readonly<{
x: number;
y: number;
}>;
hoverPointIndex: number;
segmentMidPointHoveredCoords: import("@excalidraw/math").GlobalPoint | null;
elbowed: boolean;
customLineAngle: number | null;
};
contextMenu: {
items: import("../components/ContextMenu").ContextMenuItems;
top: number;
left: number;
} | null;
showWelcomeScreen: boolean;
isLoading: boolean;
errorMessage: import("react").ReactNode;
activeEmbeddable: {
element: import("@excalidraw/element/types").NonDeletedExcalidrawElement;
state: "active" | "hover";
} | null;
newElement: import("@excalidraw/element/types").NonDeleted<import("@excalidraw/element/types").ExcalidrawNonSelectionElement> | null;
resizingElement: import("@excalidraw/element/types").NonDeletedExcalidrawElement | null;
multiElement: import("@excalidraw/element/types").NonDeleted<import("@excalidraw/element/types").ExcalidrawLinearElement> | null;
selectionElement: import("@excalidraw/element/types").NonDeletedExcalidrawElement | null;
isBindingEnabled: boolean;
startBoundElement: import("@excalidraw/element/types").NonDeleted<import("@excalidraw/element/types").ExcalidrawBindableElement> | null;
suggestedBindings: import("@excalidraw/element").SuggestedBinding[];
frameToHighlight: import("@excalidraw/element/types").NonDeleted<import("@excalidraw/element/types").ExcalidrawFrameLikeElement> | null;
frameRendering: {
enabled: boolean;
name: boolean;
outline: boolean;
clip: boolean;
};
editingFrame: string | null;
elementsToHighlight: import("@excalidraw/element/types").NonDeleted<ExcalidrawElement>[] | null;
editingTextElement: import("@excalidraw/element/types").NonDeletedExcalidrawElement | null;
activeTool: {
lastActiveTool: import("../types").ActiveTool | null;
locked: boolean;
fromSelection: boolean;
} & import("../types").ActiveTool;
penMode: boolean;
penDetected: boolean;
exportBackground: boolean;
exportEmbedScene: boolean;
exportWithDarkMode: boolean;
exportScale: number;
currentItemStrokeColor: string;
currentItemBackgroundColor: string;
currentItemFillStyle: import("@excalidraw/element/types").FillStyle;
currentItemStrokeWidth: number;
currentItemStrokeStyle: import("@excalidraw/element/types").StrokeStyle;
currentItemRoughness: number;
currentItemOpacity: number;
currentItemFontFamily: number;
currentItemFontSize: number;
currentItemTextAlign: string;
currentItemStartArrowhead: import("@excalidraw/element/types").Arrowhead | null;
currentItemEndArrowhead: import("@excalidraw/element/types").Arrowhead | null;
currentHoveredFontFamily: number | null;
currentItemRoundness: import("@excalidraw/element/types").StrokeRoundness;
currentItemArrowType: "round" | "sharp" | "elbow";
viewBackgroundColor: string;
scrollX: number;
scrollY: number;
cursorButton: "up" | "down";
scrolledOutside: boolean;
name: string | null;
isResizing: boolean;
isRotating: boolean;
zoom: Readonly<{
value: import("../types").NormalizedZoomValue;
}>;
openMenu: "canvas" | "shape" | null;
openPopup: "fontFamily" | "canvasBackground" | "elementBackground" | "elementStroke" | null;
openSidebar: {
name: string;
tab?: string | undefined;
} | null;
openDialog: {
name: "imageExport" | "help" | "jsonExport";
} | {
name: "ttd";
tab: "mermaid" | "text-to-diagram";
} | {
name: "commandPalette";
} | {
name: "elementLinkSelector";
sourceElementId: string;
} | null;
defaultSidebarDockedPreference: boolean;
lastPointerDownWith: import("@excalidraw/element/types").PointerType;
selectedElementIds: Readonly<{
[id: string]: true;
}>;
hoveredElementIds: Readonly<{
[id: string]: true;
}>;
previousSelectedElementIds: {
[id: string]: true;
};
selectedElementsAreBeingDragged: boolean;
shouldCacheIgnoreZoom: boolean;
toast: {
message: string;
closable?: boolean | undefined;
duration?: number | undefined;
} | null;
zenModeEnabled: boolean;
theme: import("@excalidraw/element/types").Theme;
gridSize: number;
gridStep: number;
gridModeEnabled: boolean;
viewModeEnabled: boolean;
selectedGroupIds: {
[groupId: string]: boolean;
};
editingGroupId: string | null;
width: number;
height: number;
offsetTop: number;
offsetLeft: number;
fileHandle: import("browser-fs-access").FileSystemHandle | null;
collaborators: Map<import("../types").SocketId, Readonly<{
pointer?: import("../types").CollaboratorPointer | undefined;
button?: "up" | "down" | undefined;
selectedElementIds?: Readonly<{
[id: string]: true;
}> | undefined;
username?: string | null | undefined;
userState?: import("@excalidraw/common").UserIdleState | undefined;
color?: {
background: string;
stroke: string;
} | undefined;
avatarUrl?: string | undefined;
id?: string | undefined;
socketId?: import("../types").SocketId | undefined;
isCurrentUser?: boolean | undefined;
isInCall?: boolean | undefined;
isSpeaking?: boolean | undefined;
isMuted?: boolean | undefined;
}>>;
stats: {
open: boolean;
panels: number;
};
currentChartType: import("@excalidraw/element/types").ChartType;
pasteDialog: {
shown: false;
data: null;
} | {
shown: true;
data: import("../charts").Spreadsheet;
};
showHyperlinkPopup: false | "editor" | "info";
selectedLinearElement: LinearElementEditor | null;
snapLines: readonly import("../snapping").SnapLine[];
originSnapOffset: {
x: number;
y: number;
} | null;
objectsSnapModeEnabled: boolean;
userToFollow: import("../types").UserToFollow | null;
followedBy: Set<import("../types").SocketId>;
isCropping: boolean;
croppingElementId: string | null;
searchMatches: Readonly<{
focusedId: string | null;
matches: readonly import("../types").SearchMatch[];
}> | null;
activeLockedId: string | null;
lockedMultiSelections: {
[groupId: string]: true;
};
};
captureUpdate: "IMMEDIATELY";
} | {
elements: ExcalidrawElement[];
appState: {
activeTool: {
lastActiveTool: import("../types").ActiveTool | null;
locked: boolean;
fromSelection: boolean;
} & import("../types").ActiveTool;
multiElement: null;
activeEmbeddable: null;
selectedLinearElement: null;
editingGroupId: string | null;
selectedElementIds: Readonly<{
[id: string]: true;
}>;
selectedGroupIds: {
[groupId: string]: boolean;
};
contextMenu: {
items: import("../components/ContextMenu").ContextMenuItems;
top: number;
left: number;
} | null;
showWelcomeScreen: boolean;
isLoading: boolean;
errorMessage: import("react").ReactNode;
newElement: import("@excalidraw/element/types").NonDeleted<import("@excalidraw/element/types").ExcalidrawNonSelectionElement> | null;
resizingElement: import("@excalidraw/element/types").NonDeletedExcalidrawElement | null;
selectionElement: import("@excalidraw/element/types").NonDeletedExcalidrawElement | null;
isBindingEnabled: boolean;
startBoundElement: import("@excalidraw/element/types").NonDeleted<import("@excalidraw/element/types").ExcalidrawBindableElement> | null;
suggestedBindings: import("@excalidraw/element").SuggestedBinding[];
frameToHighlight: import("@excalidraw/element/types").NonDeleted<import("@excalidraw/element/types").ExcalidrawFrameLikeElement> | null;
frameRendering: {
enabled: boolean;
name: boolean;
outline: boolean;
clip: boolean;
};
editingFrame: string | null;
elementsToHighlight: import("@excalidraw/element/types").NonDeleted<ExcalidrawElement>[] | null;
editingTextElement: import("@excalidraw/element/types").NonDeletedExcalidrawElement | null;
editingLinearElement: LinearElementEditor | null;
penMode: boolean;
penDetected: boolean;
exportBackground: boolean;
exportEmbedScene: boolean;
exportWithDarkMode: boolean;
exportScale: number;
currentItemStrokeColor: string;
currentItemBackgroundColor: string;
currentItemFillStyle: import("@excalidraw/element/types").FillStyle;
currentItemStrokeWidth: number;
currentItemStrokeStyle: import("@excalidraw/element/types").StrokeStyle;
currentItemRoughness: number;
currentItemOpacity: number;
currentItemFontFamily: number;
currentItemFontSize: number;
currentItemTextAlign: string;
currentItemStartArrowhead: import("@excalidraw/element/types").Arrowhead | null;
currentItemEndArrowhead: import("@excalidraw/element/types").Arrowhead | null;
currentHoveredFontFamily: number | null;
currentItemRoundness: import("@excalidraw/element/types").StrokeRoundness;
currentItemArrowType: "round" | "sharp" | "elbow";
viewBackgroundColor: string;
scrollX: number;
scrollY: number;
cursorButton: "up" | "down";
scrolledOutside: boolean;
name: string | null;
isResizing: boolean;
isRotating: boolean;
zoom: Readonly<{
value: import("../types").NormalizedZoomValue;
}>;
openMenu: "canvas" | "shape" | null;
openPopup: "fontFamily" | "canvasBackground" | "elementBackground" | "elementStroke" | null;
openSidebar: {
name: string;
tab?: string | undefined;
} | null;
openDialog: {
name: "imageExport" | "help" | "jsonExport";
} | {
name: "ttd";
tab: "mermaid" | "text-to-diagram";
} | {
name: "commandPalette";
} | {
name: "elementLinkSelector";
sourceElementId: string;
} | null;
defaultSidebarDockedPreference: boolean;
lastPointerDownWith: import("@excalidraw/element/types").PointerType;
hoveredElementIds: Readonly<{
[id: string]: true;
}>;
previousSelectedElementIds: {
[id: string]: true;
};
selectedElementsAreBeingDragged: boolean;
shouldCacheIgnoreZoom: boolean;
toast: {
message: string;
closable?: boolean | undefined;
duration?: number | undefined;
} | null;
zenModeEnabled: boolean;
theme: import("@excalidraw/element/types").Theme;
gridSize: number;
gridStep: number;
gridModeEnabled: boolean;
viewModeEnabled: boolean;
width: number;
height: number;
offsetTop: number;
offsetLeft: number;
fileHandle: import("browser-fs-access").FileSystemHandle | null;
collaborators: Map<import("../types").SocketId, Readonly<{
pointer?: import("../types").CollaboratorPointer | undefined;
button?: "up" | "down" | undefined;
selectedElementIds?: Readonly<{
[id: string]: true;
}> | undefined;
username?: string | null | undefined;
userState?: import("@excalidraw/common").UserIdleState | undefined;
color?: {
background: string;
stroke: string;
} | undefined;
avatarUrl?: string | undefined;
id?: string | undefined;
socketId?: import("../types").SocketId | undefined;
isCurrentUser?: boolean | undefined;
isInCall?: boolean | undefined;
isSpeaking?: boolean | undefined;
isMuted?: boolean | undefined;
}>>;
stats: {
open: boolean;
panels: number;
};
currentChartType: import("@excalidraw/element/types").ChartType;
pasteDialog: {
shown: false;
data: null;
} | {
shown: true;
data: import("../charts").Spreadsheet;
};
showHyperlinkPopup: false | "editor" | "info";
snapLines: readonly import("../snapping").SnapLine[];
originSnapOffset: {
x: number;
y: number;
} | null;
objectsSnapModeEnabled: boolean;
userToFollow: import("../types").UserToFollow | null;
followedBy: Set<import("../types").SocketId>;
isCropping: boolean;
croppingElementId: string | null;
searchMatches: Readonly<{
focusedId: string | null;
matches: readonly import("../types").SearchMatch[];
}> | null;
activeLockedId: string | null;
lockedMultiSelections: {
[groupId: string]: true;
};
};
captureUpdate: "IMMEDIATELY" | "EVENTUALLY";
};
keyTest: (event: KeyboardEvent | import("react").KeyboardEvent<Element>, appState: AppState, elements: readonly ExcalidrawElement[]) => boolean;
PanelComponent: ({ elements, appState, updateData }: import("./types").PanelComponentProps) => import("react/jsx-runtime").JSX.Element;
} & {
keyTest?: ((event: KeyboardEvent | import("react").KeyboardEvent<Element>, appState: AppState, elements: readonly ExcalidrawElement[]) => boolean) | undefined;
};