Skip to content

Commit

Permalink
Updated to clear rtd cell on provider close (#57)
Browse files Browse the repository at this point in the history
Updated dependencies for the add in (around packaging/zipping) to be latest stable.
Removed the option to not clear rtd topic cells when calling dispose as we now clear the cell value when the provider is shutdown.
Updated output of index.d.ts in src so it could be used for typing information.
Updated documentation.
  • Loading branch information
johnman committed Mar 19, 2021
1 parent 4140f47 commit 693881a
Show file tree
Hide file tree
Showing 12 changed files with 184 additions and 180 deletions.
9 changes: 3 additions & 6 deletions DOCS.md
Expand Up @@ -493,19 +493,16 @@ rtd.setValue('Topic1', 123.55);
### Excel RTD Functionality (New in 4.0.0)
From version 4.0 you can dispose the rtd instance that you created. You have the option of specifying whether or not you want pushed values cleared (as you may want some rtd instances to behave differently). You should call dispose if your application is closing or if you no longer need the functionality.
From version 4.0 you can dispose the rtd instance that you created. You should call dispose if your application is closing or if you no longer need the functionality.
```javascript
const rtd = await fin.desktop.ExcelService.createRtd('Provider1');

// Will stop listening to excel and will tell excel to clear all values in the connected topics
// When the excel provider service closes we will clear the cells as well but that won't happen if another application
// is still using the excel service so you should always try and tidy up and dispose when your application is about to close.
await rtd.dispose();

// OR

// Will stop listening to excel and but will NOT tell excel to clear all values in the connected topics
await rtd.dispose(false);

```
### Excel Self Hosting
Expand Down

0 comments on commit 693881a

Please sign in to comment.