Perspective restore() config

catalog/app/components/Preview/loaders/summarize.ts

@@ -1,3 +1,5 @@
+import type { PerspectiveViewerConfig } from '@finos/perspective-viewer'
+
 export type TypeShorthand =
   | 'echarts'
   | 'json'
@@ -13,7 +15,7 @@ export interface StyleOptions {
 }
 
 export interface PerspectiveOptions {
-  settings?: boolean
+  config?: PerspectiveViewerConfig
 }
 
 interface TypeExtendedEssentials {

catalog/app/components/Preview/renderers/Perspective/Perspective.tsx

@@ -212,15 +212,15 @@ export default function Perspective({
   handle,
   onLoadMore,
   truncated,
-  settings,
+  config,
   ...props
 }: PerspectiveProps) {
   const classes = useStyles()
 
   const [root, setRoot] = React.useState<HTMLDivElement | null>(null)
 
   const attrs = React.useMemo(() => ({ className: classes.viewer }), [classes])
-  const state = perspective.use(root, data, attrs, settings)
+  const state = perspective.use(root, data, attrs, config)
 
   return (
     <div className={cx(className, classes.root)} ref={setRoot} {...props}>

catalog/app/utils/perspective.ts

@@ -6,7 +6,10 @@ import 'utils/perspective-pollution'
 
 import perspective from '@finos/perspective'
 import type { Table } from '@finos/perspective'
-import type { HTMLPerspectiveViewerElement } from '@finos/perspective-viewer'
+import type {
+  HTMLPerspectiveViewerElement,
+  PerspectiveViewerConfig,
+} from '@finos/perspective-viewer'
 
 export interface State {
   size: number | null
@@ -39,7 +42,7 @@ function usePerspective(
   container: HTMLDivElement | null,
   data: string | ArrayBuffer,
   attrs: React.HTMLAttributes<HTMLDivElement>,
-  settings?: boolean,
+  config?: PerspectiveViewerConfig,
 ) {
   const [state, setState] = React.useState<State | null>(null)
 
@@ -54,8 +57,8 @@ function usePerspective(
       viewer = renderViewer(container, attrs)
       table = await renderTable(data, viewer)
 
-      if (settings) {
-        await viewer.toggleConfig(true)
+      if (config) {
+        await viewer.restore(config)
       }
 
       const size = await table.size()
@@ -76,7 +79,7 @@ function usePerspective(
     return () => {
       disposeTable()
     }
-  }, [attrs, container, data, settings])
+  }, [attrs, config, container, data])
 
   return state
 }

docs/CHANGELOG.md

@@ -9,6 +9,7 @@
 ## Catalog, Lambdas
 * [Added] Use `quilt_summarize.json` to control Perspective menu ([#2744](https://github.com/quiltdata/quilt/pull/2744))
 * [Added] Show bucket collaborators ([#2756](https://github.com/quiltdata/quilt/pull/2756))
+* [Added] Add `config` field to Perspective scope of `quilt_summarize.json` ([#2781](https://github.com/quiltdata/quilt/pull/2781))
 * [Fixed] Fix package creation in S3 buckets with SSE-KMS enabled ([#2754](https://github.com/quiltdata/quilt/pull/2754))
 * [Changed] Clean up home page ([#2780](https://github.com/quiltdata/quilt/pull/2780)).
 

shared/schemas/quilt_summarize.json

@@ -63,6 +63,10 @@
             }
           }
         },
+        "config": {
+          "description": "Perspctive specific option. Restores config from .save()",
+          "type": "object"
+        },
         "settings": {
           "description": "Perspctive specific option. Sets config opened",
           "type": "boolean"