Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
NikitchenkoSergey authored Mar 10, 2018
1 parent 62b8691 commit 6aa9c22
Showing 1 changed file with 41 additions and 0 deletions.
41 changes: 41 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,9 @@ for adaptive add wrapper (relative):
```
var canvas = document.getElementById('canvas');
var schemeDesigner = new SchemeDesigner.Scheme(canvas, {
options: {
cacheSchemeRatio: 2
},
scroll: {
maxHiddenPart: 0.85
},
Expand Down Expand Up @@ -70,6 +73,14 @@ schemeDesigner.render();
<th>Option</th>
<th>Default</th>
<th>Description</th>
</tr>
<tr>
<td colspan=3 align=center><strong>Options</strong></td>
</tr>
<tr>
<td>cacheSchemeRatio</td>
<td>2</td>
<td>Ratio for scheme cache. Set false to disable cache.</td>
</tr>
<tr>
<td colspan=3 align=center><strong>Scroll</strong></td>
Expand Down Expand Up @@ -127,6 +138,11 @@ schemeDesigner.render();
<td>height: number</td>
<td></td>
<td>Height</td>
</tr>
<tr>
<td>rotation: number</td>
<td></td>
<td>Rotation</td>
</tr>
<tr>
<td>cursorStyle: string</td>
Expand All @@ -153,6 +169,11 @@ schemeDesigner.render();
<td></td>
<td>Function for handle mouseleave on object</td>
</tr>
<tr>
<td>clearFunction: Function(schemeObject: SchemeObject, scheme: Scheme, view: View)</td>
<td></td>
<td>Function for clear object on scheme cache</td>
</tr>
</table>

<h2>Api</h2>
Expand Down Expand Up @@ -217,6 +238,11 @@ schemeDesigner.getStorageManager().showNodesParts();
<td>SchemeDesigner</td>
<td>Request redraw canvas</td>
</tr>
<tr>
<td>requestDrawFromCache()</td>
<td>SchemeDesigner</td>
<td>Request draw scheme from cache</td>
</tr>
<tr>
<td>render()</td>
<td></td>
Expand Down Expand Up @@ -256,6 +282,21 @@ schemeDesigner.getStorageManager().showNodesParts();
<td>setCursorStyle(cursor: string)</td>
<td>SchemeDesigner</td>
<td>Set cursor style</td>
</tr>
<tr>
<td>updateCache(onlyChanged: boolean)</td>
<td></td>
<td>Redraw scheme cache</td>
</tr>
<tr>
<td>getView()</td>
<td>View</td>
<td>Main view</td>
</tr>
<tr>
<td>addChangedObject(schemeObject: SchemeObject)</td>
<td></td>
<td>Add object to changed list for redraw cache</td>
</tr>
<tr>
<td colspan=3 align=center><strong>Scroll manager</strong></td>
Expand Down

0 comments on commit 6aa9c22

Please sign in to comment.