AG-11148 Fix annotations save/restore api typing and example

ag-grid · May 28, 2024 · 349def4 · 349def4
1 parent 6ad578b
commit 349def4
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 2 deletions.
diff --git a/packages/ag-charts-community/src/options/chart/chartBuilderOptions.ts b/packages/ag-charts-community/src/options/chart/chartBuilderOptions.ts
@@ -84,7 +84,7 @@ export interface AgChartInstance<O extends AgChartOptions = AgChartOptions> {
  /** Returns a base64-encoded image data URL for the given `AgChartInstance`.*/
  getImageDataURL(options?: ImageDataUrlOptions): Promise<string>;
 
- saveAnnotations(): Promise<unknown>;
+ saveAnnotations(): Promise<string>;
  restoreAnnotations(blob: unknown): Promise<void>;
 
  /** Destroy the chart instance and any allocated resources to support its rendering. */

diff --git a/.../ag-charts-website/src/content/docs/annotations/_examples/annotation-save-restore/main.ts b/.../ag-charts-website/src/content/docs/annotations/_examples/annotation-save-restore/main.ts
@@ -58,7 +58,8 @@ let blob =
  'eyJhbm5vdGF0aW9ucyI6W3sidHlwZSI6InBhcmFsbGVsLWNoYW5uZWwiLCJzaXplIjoxMi40NjA3MzI5ODQyOTEwOTksIm1pZGRsZSI6eyJzdHJva2VXaWR0aCI6MSwibGluZURhc2giOls2LDVdfSwiYmFja2dyb3VuZCI6eyJmaWxsIjoiIzUwOTBkYyIsImZpbGxPcGFjaXR5IjowLjJ9LCJzdGFydCI6eyJ4IjoiMjAyNC0wMy0yMVQxODo0NTowMC4wMDBaIiwieSI6Mzk4MjYuNDkyMTQ2NTk2ODZ9LCJlbmQiOnsieCI6IjIwMjQtMDMtMjFUMTg6NTY6MDAuMDAwWiIsInkiOjM5ODQxLjM2MTI1NjU0NDV9LCJoYW5kbGUiOnsiZmlsbCI6IndoaXRlIn0sInN0cm9rZSI6IiMyYjVjOTUiLCJzdHJva2VPcGFjaXR5IjoxLCJzdHJva2VXaWR0aCI6Mn0seyJ0eXBlIjoicGFyYWxsZWwtY2hhbm5lbCIsInNpemUiOjEyLjYxNzgwMTA0NzExOTQyOCwibWlkZGxlIjp7InN0cm9rZVdpZHRoIjoxLCJsaW5lRGFzaCI6WzYsNV19LCJiYWNrZ3JvdW5kIjp7ImZpbGwiOiIjNTA5MGRjIiwiZmlsbE9wYWNpdHkiOjAuMn0sInN0YXJ0Ijp7IngiOnsiX190eXBlIjoiZGF0ZSIsInZhbHVlIjoiVGh1IE1hciAyMSAyMDI0IDE4OjQzOjAwIEdNVCswMDAwIChHcmVlbndpY2ggTWVhbiBUaW1lKSJ9LCJ5IjozOTgyNC44NjkxMDk5NDc2NH0sImVuZCI6eyJ4Ijp7Il9fdHlwZSI6ImRhdGUiLCJ2YWx1ZSI6IlRodSBNYXIgMjEgMjAyNCAxODo1NjowMCBHTVQrMDAwMCAoR3JlZW53aWNoIE1lYW4gVGltZSkifSwieSI6Mzk4NDAuMDUyMzU2MDIwOTR9LCJoYW5kbGUiOnsiZmlsbCI6IndoaXRlIn0sInN0cm9rZSI6IiMyYjVjOTUiLCJzdHJva2VPcGFjaXR5IjoxLCJzdHJva2VXaWR0aCI6Mn1dLCJ0eXBlIjoiYW5ub3RhdGlvbnMiLCJ2ZXJzaW9uIjoiMTAuMCJ9';
 
 function saveAnnotations() {
- chart.saveAnnotations().then((blob) => {
+ chart.saveAnnotations().then((b) => {
+ blob = b;
  console.log(`Saving [${blob}]`);
  });
 }