Skip to content

Commit 8d36829

Browse files
committed
docs: add events to README
Signed-off-by: Snehil Shah <snehilshah.989@gmail.com>
1 parent 2c7c604 commit 8d36829

File tree

1 file changed

+30
-0
lines changed
  • lib/node_modules/@stdlib/plot/table/unicode

1 file changed

+30
-0
lines changed

lib/node_modules/@stdlib/plot/table/unicode/README.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -506,6 +506,36 @@ var str = table.render();
506506

507507
* * *
508508

509+
### Events
510+
511+
#### 'change'
512+
513+
Emitted whenever a property value changes.
514+
515+
```javascript
516+
var table = new UnicodeTable();
517+
518+
table.on( 'change', onChange );
519+
520+
function onChange() {
521+
console.log( 'A property was updated.' );
522+
}
523+
```
524+
525+
#### 'render'
526+
527+
Emitted whenever a sparkline is rendered.
528+
529+
```javascript
530+
var table = new UnicodeTable();
531+
532+
table.on( 'render', onRender );
533+
534+
function onRender( str ) {
535+
console.log( 'Rendered table: %s', str );
536+
}
537+
```
538+
509539
</section>
510540

511541
<!-- /.usage -->

0 commit comments

Comments
 (0)