mirror of
https://github.com/zsviczian/obsidian-excalidraw-plugin.git
synced 2025-08-06 05:46:28 +00:00
60 lines
2.6 KiB
Markdown
60 lines
2.6 KiB
Markdown
# [◀ Excalidraw Automate How To](../readme.md)
|
|
## Attributes and functions overview
|
|
Here's the interface implemented by ExcalidrawAutomate:
|
|
|
|
```typescript
|
|
ExcalidrawAutomate: {
|
|
plugin: ExcalidrawPlugin;
|
|
elementsDict: {};
|
|
style: {
|
|
strokeColor: string;
|
|
backgroundColor: string;
|
|
angle: number;
|
|
fillStyle: FillStyle;
|
|
strokeWidth: number;
|
|
storkeStyle: StrokeStyle;
|
|
roughness: number;
|
|
opacity: number;
|
|
strokeSharpness: StrokeSharpness;
|
|
fontFamily: number;
|
|
fontSize: number;
|
|
textAlign: string;
|
|
verticalAlign: string;
|
|
startArrowHead: string;
|
|
endArrowHead: string;
|
|
}
|
|
canvas: {theme: string, viewBackgroundColor: string, gridSize: number};
|
|
setFillStyle(val:number): void;
|
|
setStrokeStyle(val:number): void;
|
|
setStrokeSharpness(val:number): void;
|
|
setFontFamily(val:number): void;
|
|
setTheme(val:number): void;
|
|
addToGroup(objectIds:[]):string;
|
|
toClipboard(templatePath?:string): void;
|
|
getElements():ExcalidrawElement[];
|
|
getElement(id:string):ExcalidrawElement;
|
|
create(params?:{filename?: string, foldername?:string, templatePath?:string, onNewPane?: boolean}):Promise<void>;
|
|
createSVG(templatePath?:string):Promise<SVGSVGElement>;
|
|
createPNG(templatePath?:string):Promise<any>;
|
|
wrapText(text:string, lineLen:number):string;
|
|
addRect(topX:number, topY:number, width:number, height:number):string;
|
|
addDiamond(topX:number, topY:number, width:number, height:number):string;
|
|
addEllipse(topX:number, topY:number, width:number, height:number):string;
|
|
addText(topX:number, topY:number, text:string, formatting?:{width?:number, height?:number,textAlign?: string, verticalAlign?:string, box?: boolean, boxPadding?: number},id?:string):string;
|
|
addLine(points: [[x:number,y:number]]):string;
|
|
addArrow(points: [[x:number,y:number]],formatting?:{startArrowHead?:string,endArrowHead?:string,startObjectId?:string,endObjectId?:string}):string;
|
|
connectObjects(objectA: string, connectionA: ConnectionPoint, objectB: string, connectionB: ConnectionPoint, formatting?:{numberOfPoints?: number,startArrowHead?:string,endArrowHead?:string, padding?: number}):void;
|
|
clear(): void;
|
|
reset(): void;
|
|
isExcalidrawFile(f:TFile): boolean;
|
|
//view manipulation
|
|
targetView: ExcalidrawView;
|
|
setView(view:ExcalidrawView|"first"|"active"):ExcalidrawView;
|
|
getExcalidrawAPI():any;
|
|
getViewSelectedElement():ExcalidrawElement;
|
|
connectObjectWithViewSelectedElement(objectA:string,connectionA: ConnectionPoint, connectionB: ConnectionPoint, formatting?:{numberOfPoints?: number,startArrowHead?:string,endArrowHead?:string, padding?: number}):boolean;
|
|
addElementsToView(repositionToCursor:boolean, save:boolean):Promise<boolean>;
|
|
};
|
|
```
|
|
|