Skip to content

Commit

Permalink
Remove scale from drawing API readme
Browse files Browse the repository at this point in the history
  • Loading branch information
eatyourgreens committed Feb 18, 2025
1 parent 492f241 commit 38cb5c8
Showing 1 changed file with 1 addition and 2 deletions.
3 changes: 1 addition & 2 deletions packages/lib-classifier/src/plugins/drawingTools/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,10 @@ A React component for a mark takes a Mark model and renders it as SVG. The basic

```jsx
const MarkComponent = mark.toolComponent
<MarkComponent active mark={mark} scale={scale} onFinish={onFinish} />
<MarkComponent active mark={mark} onFinish={onFinish} />
```

- _mark_ is the mark model to render.
- _scale_ is the linear scale of the subject image (_clientWidth_ / _naturalWidth_).
- _active_ is a boolean attribute indicating whether the mark is currently editable.
- _onFinish_ is a callback that should be called when initial creation of the mark is complete. It resets the drawing canvas and tells it to start listening to clicks to create new marks again.

Expand Down

0 comments on commit 38cb5c8

Please sign in to comment.