Skip to content

Virtual whiteboard for sketching hand-drawn like diagrams

Excalicharts MVP (#1723)

Pete Huntf7c4efbd3549
diff --git a/src/charts.ts b/src/charts.ts
new file mode 100644
index 0000000000..85913c4dce
--- /dev/null
+++ b/src/charts.ts
@@ -0,0 +1,257 @@
+import { ExcalidrawElement } from "./element/types";
+import { newElement, newTextElement } from "./element";
+import { AppState } from "./types";
+import { t } from "./i18n";
+
+interface Spreadsheet {
+ yAxisLabel: string | null;
+ labels: string[] | null;
+ values: number[];
+}
+
+type ParseSpreadsheetResult =
+ | {
+ type: "not a spreadsheet";
+ }
+ | { type: "spreadsheet"; spreadsheet: Spreadsheet }
+ | {
+ type: "malformed spreadsheet";
+ error: string;
+ };
+
+function tryParseNumber(s: string): number | null {
+ const match = /^[$€£¥₩]?([0-9]+(\.[0-9]+)?)$/.exec(s);
+ if (!match) {
+ return null;
+ }
+ return parseFloat(match[1]);
+}
+
+function isNumericColumn(lines: string[][], columnIndex: number) {
+ return lines
+ .slice(1)
+ .every((line) => tryParseNumber(line[columnIndex]) !== null);
+}
+
+function tryParseCells(cells: string[][]): ParseSpreadsheetResult {
+ const numCols = cells[0].length;
+
+ if (numCols > 2) {
+ return { type: "malformed spreadsheet", error: t("charts.tooManyColumns") };
+ }
+
+ if (numCols === 1) {
+ if (!isNumericColumn(cells, 0)) {
+ return { type: "not a spreadsheet" };
+ }
+
+ const hasHeader = tryParseNumber(cells[0][0]) === null;
+ const values = (hasHeader ? cells.slice(1) : cells).map((line) =>
+ tryParseNumber(line[0]),
+ );
+
+ if (values.length < 2) {
+ return { type: "not a spreadsheet" };
+ }
+
+ return {
+ type: "spreadsheet",
+ spreadsheet: {
+ yAxisLabel: hasHeader ? cells[0][0] : null,
+ labels: null,
+ values: values as number[],
+ },
+ };
+ }
+
+ const valueColumnIndex = isNumericColumn(cells, 0) ? 0 : 1;
+
+ if (!isNumericColumn(cells, valueColumnIndex)) {
+ return {
+ type: "malformed spreadsheet",
+ error: t("charts.noNumericColumn"),
+ };
+ }
+
+ const labelColumnIndex = (valueColumnIndex + 1) % 2;
+ const hasHeader = tryParseNumber(cells[0][valueColumnIndex]) === null;
+ const rows = hasHeader ? cells.slice(1) : cells;
+
+ if (rows.length < 2) {
+ return { type: "not a spreadsheet" };
+ }
+
+ return {
+ type: "spreadsheet",
+ spreadsheet: {
+ yAxisLabel: hasHeader ? cells[0][valueColumnIndex] : null,
+ labels: rows.map((row) => row[labelColumnIndex]),
+ values: rows.map((row) => tryParseNumber(row[valueColumnIndex])!),
+ },
+ };
+}
+
+function transposeCells(cells: string[][]) {
+ const nextCells: string[][] = [];
+ for (let col = 0; col < cells[0].length; col++) {
+ const nextCellRow: string[] = [];
+ for (let row = 0; row < cells.length; row++) {
+ nextCellRow.push(cells[row][col]);
+ }
+ nextCells.push(nextCellRow);
+ }
+
+ return nextCells;
+}
+
+export function tryParseSpreadsheet(text: string): ParseSpreadsheetResult {
+ // copy/paste from excel, in-browser excel, and google sheets is tsv
+ // for now we only accept 2 columns with an optional header
+ const lines = text
+ .trim()
+ .split("\n")
+ .map((line) => line.trim().split("\t"));
+
+ if (lines.length === 0) {
+ return { type: "not a spreadsheet" };
+ }
+
+ const numColsFirstLine = lines[0].length;
+ const isASpreadsheet = lines.every(
+ (line) => line.length === numColsFirstLine,
+ );
+
+ if (!isASpreadsheet) {
+ return { type: "not a spreadsheet" };
+ }
+
+ const result = tryParseCells(lines);
+ if (result.type !== "spreadsheet") {
+ const transposedResults = tryParseCells(transposeCells(lines));
+ if (transposedResults.type === "spreadsheet") {
+ return transposedResults;
+ }
+ }
+
+ return result;
+}
+
+const BAR_WIDTH = 32;
+const BAR_SPACING = 12;
+const BAR_HEIGHT = 192;
+const LABEL_SPACING = 3 * BAR_SPACING;
+const Y_AXIS_LABEL_SPACING = LABEL_SPACING;
+const ANGLE = 5.87;
+
+export function renderSpreadsheet(
+ appState: AppState,
+ spreadsheet: Spreadsheet,
+ x: number,
+ y: number,
+): ExcalidrawElement[] {
+ const max = Math.max(...spreadsheet.values);
+ const min = Math.min(0, ...spreadsheet.values);
+ const range = max - min;
+
+ const minYLabel = newTextElement({
+ x: x,
+ y: y + BAR_HEIGHT,
+ strokeColor: appState.currentItemStrokeColor,
+ backgroundColor: appState.currentItemBackgroundColor,
+ fillStyle: appState.currentItemFillStyle,
+ strokeWidth: appState.currentItemStrokeWidth,
+ strokeStyle: appState.currentItemStrokeStyle,
+ roughness: appState.currentItemRoughness,
+ opacity: appState.currentItemOpacity,
+ text: min.toLocaleString(),
+ fontSize: 16,
+ fontFamily: appState.currentItemFontFamily,
+ textAlign: appState.currentItemTextAlign,
+ });
+
+ const maxYLabel = newTextElement({
+ x: x,
+ y: y,
+ strokeColor: appState.currentItemStrokeColor,
+ backgroundColor: appState.currentItemBackgroundColor,
+ fillStyle: appState.currentItemFillStyle,
+ strokeWidth: appState.currentItemStrokeWidth,
+ strokeStyle: appState.currentItemStrokeStyle,
+ roughness: appState.currentItemRoughness,
+ opacity: appState.currentItemOpacity,
+ text: max.toLocaleString(),
+ fontSize: 16,
+ fontFamily: appState.currentItemFontFamily,
+ textAlign: appState.currentItemTextAlign,
+ });
+
+ const bars = spreadsheet.values.map((value, i) => {
+ const valueBarHeight = value - min;
+ const percentBarHeight = valueBarHeight / range;
+ const barHeight = percentBarHeight * BAR_HEIGHT;
+ const barX = i * (BAR_WIDTH + BAR_SPACING) + LABEL_SPACING;
+ const barY = BAR_HEIGHT - barHeight;
+ return newElement({
+ type: "rectangle",
+ x: barX + x,
+ y: barY + y,
+ width: BAR_WIDTH,
+ height: barHeight,
+ strokeColor: appState.currentItemStrokeColor,
+ backgroundColor: appState.currentItemBackgroundColor,
+ fillStyle: appState.currentItemFillStyle,
+ strokeWidth: appState.currentItemStrokeWidth,
+ strokeStyle: appState.currentItemStrokeStyle,
+ roughness: appState.currentItemRoughness,
+ opacity: appState.currentItemOpacity,
+ });
+ });
+
+ const xLabels =
+ spreadsheet.labels?.map((label, i) => {
+ const labelX =
+ i * (BAR_WIDTH + BAR_SPACING) + LABEL_SPACING + BAR_SPACING;
+ const labelY = BAR_HEIGHT + BAR_SPACING;
+ return newTextElement({
+ text: label.length > 8 ? `${label.slice(0, 5)}...` : label,
+ x: x + labelX,
+ y: y + labelY,
+ strokeColor: appState.currentItemStrokeColor,
+ backgroundColor: appState.currentItemBackgroundColor,
+ fillStyle: appState.currentItemFillStyle,
+ strokeWidth: appState.currentItemStrokeWidth,
+ strokeStyle: appState.currentItemStrokeStyle,
+ roughness: appState.currentItemRoughness,
+ opacity: appState.currentItemOpacity,
+ fontSize: 16,
+ fontFamily: appState.currentItemFontFamily,
+ textAlign: "center",
+ width: BAR_WIDTH,
+ angle: ANGLE,
+ });
+ }) || [];
+
+ const yAxisLabel = spreadsheet.yAxisLabel
+ ? newTextElement({
+ text: spreadsheet.yAxisLabel,
+ x: x - Y_AXIS_LABEL_SPACING,
+ y: y + BAR_HEIGHT / 2 - 10,
+ strokeColor: appState.currentItemStrokeColor,
+ backgroundColor: appState.currentItemBackgroundColor,
+ fillStyle: appState.currentItemFillStyle,
+ strokeWidth: appState.currentItemStrokeWidth,
+ strokeStyle: appState.currentItemStrokeStyle,
+ roughness: appState.currentItemRoughness,
+ opacity: appState.currentItemOpacity,
+ fontSize: 20,
+ fontFamily: appState.currentItemFontFamily,
+ textAlign: "center",
+ width: BAR_WIDTH,
+ angle: ANGLE,
+ })
+ : null;
+
+ return [...bars, yAxisLabel, minYLabel, maxYLabel, ...xLabels].filter(
+ (element) => element !== null,
+ ) as ExcalidrawElement[];
+}
diff --git a/src/clipboard.ts b/src/clipboard.ts
index 31d1176916..3ce3b2c4e2 100644
--- a/src/clipboard.ts
+++ b/src/clipboard.ts
@@ -5,6 +5,7 @@ import {
import { getSelectedElements } from "./scene";
import { AppState } from "./types";
import { SVG_EXPORT_TAG } from "./scene/export";
+import { tryParseSpreadsheet, renderSpreadsheet } from "./charts";
let CLIPBOARD = "";
let PREFER_APP_CLIPBOARD = false;
@@ -65,10 +66,14 @@ export const getAppClipboard = (): {
};
export const getClipboardContent = async (
+ appState: AppState,
+ cursorX: number,
+ cursorY: number,
event: ClipboardEvent | null,
): Promise<{
text?: string;
elements?: readonly ExcalidrawElement[];
+ error?: string;
}> => {
try {
const text = event
@@ -77,6 +82,19 @@ export const getClipboardContent = async (
(await navigator.clipboard.readText());
if (text && !PREFER_APP_CLIPBOARD && !text.includes(SVG_EXPORT_TAG)) {
+ const result = tryParseSpreadsheet(text);
+ if (result.type === "spreadsheet") {
+ return {
+ elements: renderSpreadsheet(
+ appState,
+ result.spreadsheet,
+ cursorX,
+ cursorY,
+ ),
+ };
+ } else if (result.type === "malformed spreadsheet") {
+ return { error: result.error };
+ }
return { text };
}
} catch (error) {
diff --git a/src/components/App.tsx b/src/components/App.tsx
index 6412b034da..a57b59e1a7 100644
--- a/src/components/App.tsx
+++ b/src/components/App.tsx
@@ -707,8 +707,15 @@ class App extends React.Component<any, AppState> {
) {
return;
}
- const data = await getClipboardContent(event);
- if (data.elements) {
+ const data = await getClipboardContent(
+ this.state,
+ cursorX,
+ cursorY,
+ event,
+ );
+ if (data.error) {
+ alert(data.error);
+ } else if (data.elements) {
this.addElementsFromPaste(data.elements);
} else if (data.text) {
this.addTextFromPaste(data.text);
diff --git a/src/locales/en.json b/src/locales/en.json
index 276fd72de9..a4caaea8d1 100644
--- a/src/locales/en.json
+++ b/src/locales/en.json
@@ -171,5 +171,9 @@
},
"encrypted": {
"tooltip": "Your drawings are end-to-end encrypted so Excalidraw's servers will never see them."
+ },
+ "charts": {
+ "noNumericColumn": "You pasted a spreadsheet without a numeric column.",
+ "tooManyColumns": "You pasted a spreadsheet with more than two columns."
}
}