aboutsummaryrefslogtreecommitdiff
path: root/src/client/views/ViewBoxInterface.ts
diff options
context:
space:
mode:
authorbobzel <zzzman@gmail.com>2024-10-28 20:08:35 -0400
committerbobzel <zzzman@gmail.com>2024-10-28 20:08:35 -0400
commitc45e21a8960298b77c3508b047cfbd9fdcf2c602 (patch)
treea0fabfd203267963e7a8a648ac01793b08bbdcf4 /src/client/views/ViewBoxInterface.ts
parent8ac260db2fdffc37ff9b6e91971f287df6a70528 (diff)
parent63f9f9573dab9745d2f570e1917b325a474fdd93 (diff)
Merge branch 'master' into alyssa-starter
Diffstat (limited to 'src/client/views/ViewBoxInterface.ts')
-rw-r--r--src/client/views/ViewBoxInterface.ts2
1 files changed, 1 insertions, 1 deletions
diff --git a/src/client/views/ViewBoxInterface.ts b/src/client/views/ViewBoxInterface.ts
index f66f6062e..b7980d74e 100644
--- a/src/client/views/ViewBoxInterface.ts
+++ b/src/client/views/ViewBoxInterface.ts
@@ -24,7 +24,7 @@ export abstract class ViewBoxInterface<P> extends ObservableReactComponent<React
promoteCollection?: () => void; // moves contents of collection to parent
updateIcon?: (usePanelDimensions?: boolean) => Promise<void>; // updates the icon representation of the document
getAnchor?: (addAsAnnotation: boolean, pinData?: PinProps) => Doc; // returns an Anchor Doc that represents the current state of the doc's componentview (e.g., the current playhead location of a an audio/video box)
- restoreView?: (viewSpec: Doc) => boolean;
+ restoreView?: (viewSpec: Doc) => boolean; // DEPRECATED: do not use, it will go away. see PresBox.restoreTargetDocView
scrollPreview?: (docView: DocumentView, doc: Doc, focusSpeed: number, options: FocusViewOptions) => Opt<number>; // returns the duration of the focus
brushView?: (view: { width: number; height: number; panX: number; panY: number }, transTime: number, holdTime: number) => void; // highlight a region of a view (used by freeforms)
getView?: (doc: Doc, options: FocusViewOptions) => Promise<Opt<DocumentView>>; // returns a nested DocumentView for the specified doc or undefined