renun/obsidian-excalidraw-plugin
1
0
Fork 0
mirror of https://github.com/zsviczian/obsidian-excalidraw-plugin.git synced 2025-08-06 05:46:28 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

1.3.0

Browse Source
This commit is contained in:
Zsolt Viczian
2021-09-03 18:47:25 +02:00
parent f5307db33e
commit c670ecb09c
6 changed files with 147 additions and 56 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
docs/API/objects.md
View File

@@ -28,13 +28,15 @@ Returns the `id` of the object. The `id` is required when connecting objects wit
### addLine()
```typescript
addLine(points: [[x:number,y:number]]):void
addLine(points: [[x:number,y:number]]):string
```
Adds a line following the points provided. Must include at least two points `points.length >= 2`. If more than 2 points are provided the interim points will be added as breakpoints. The line will break with angles if `strokeSharpness` is set to "sharp" and will be curvey if it is set to "round".
Returns the `id` of the object.
### addArrow()
```typescript
addArrow(points: [[x:number,y:number]],formatting?:{startArrowHead:string,endArrowHead:string,startObjectId:string,endObjectId:string}):void
addArrow(points: [[x:number,y:number]],formatting?:{startArrowHead?:string,endArrowHead?:string,startObjectId?:string,endObjectId?:string}):string ;
```
Adds an arrow following the points provided. Must include at least two points `points.length >= 2`. If more than 2 points are provided the interim points will be added as breakpoints. The line will break with angles if element `style.strokeSharpness` is set to "sharp" and will be curvey if it is set to "round".
@@ -43,6 +45,8 @@ Adds an arrow following the points provided. Must include at least two points `p
`startObjectId` and `endObjectId` are the object id's of connected objects. I recommend using `connectObjects` instead calling addArrow() for the purpose of connecting objects.
Returns the `id` of the object.
### connectObjects()
```typescript
declare type ConnectionPoint = "top"|"bottom"|"left"|"right";
@@ -60,6 +64,6 @@ Connects two objects with an arrow.
### addToGroup()
```typescript
addToGroup(objectIds:[]):void
addToGroup(objectIds:[]):string
```
Groups objects listed in `objectIds`.
Groups objects listed in `objectIds`. Returns the `id` of the group.