excalidraw-excalidraw
- Description:
Transform your creative process with Excalidraw, the ultimate open-source whiteboard perfect for collaborative, hand-drawn style designs. Enjoy infinite canvas, customizable tools, and real-time collaboration.
- Copyright:
- 2025 Eyevinn Technology AB
Methods
(async, static) createExcalidrawExcalidrawInstance(context, body) → {ExcalidrawExcalidraw}
- Description:
Create a new Excalidraw instance
Example
import { Context } from '@osaas/client-core';
import { createExcalidrawExcalidrawInstance } from '@osaas/client-services';
const ctx = new Context();
const body: ExcalidrawExcalidrawConfig = { name: 'myinstance', ... };
const instance = await createExcalidrawExcalidrawInstance(ctx, body);
console.log(instance.url);Parameters:
| Name | Type | Description |
|---|---|---|
context |
Context | Open Source Cloud configuration context |
body |
ExcalidrawExcalidrawConfig | Service instance configuration |
Returns:
- Service instance
- Type
- ExcalidrawExcalidraw
(async, static) getExcalidrawExcalidrawInstance(context, name) → {ExcalidrawExcalidraw}
- Description:
Get a Excalidraw instance
Example
import { Context } from '@osaas/client-core';
import { getExcalidrawExcalidrawInstance } from '@osaas/client-services';
const ctx = new Context();
const instance = await getExcalidrawExcalidrawInstance(ctx, 'myinstance');
console.log(instance.url);Parameters:
| Name | Type | Description |
|---|---|---|
context |
Context | Open Source Cloud configuration context |
name |
string | Name of the editor to be retrieved |
Returns:
- Service instance
- Type
- ExcalidrawExcalidraw
(async, static) removeExcalidrawExcalidrawInstance(context, name)
- Description:
Remove a Excalidraw instance
Parameters:
| Name | Type | Description |
|---|---|---|
context |
Context | Open Source Cloud configuration context |
name |
string | Name of the editor to be removed |