Update auto-gen docs

GMOD · Mar 7, 2023 · 70d0672 · 70d0672
1 parent 4f6f926
commit 70d0672
Show file tree

Hide file tree

Showing 11 changed files with 296 additions and 35 deletions.
diff --git a/plugins/sv-inspector/src/SvInspectorView/models/SvInspectorView.ts b/plugins/sv-inspector/src/SvInspectorView/models/SvInspectorView.ts
@@ -24,7 +24,7 @@ import {
  * #stateModel SvInspectorView
  * combination of a spreadsheetview and a circularview
  */
-const SvInspectorViewF = (pluginManager: PluginManager) => {
+function SvInspectorViewF(pluginManager: PluginManager) {
   const SpreadsheetViewType = pluginManager.getViewType('SpreadsheetView')
   const CircularViewType = pluginManager.getViewType('CircularView')
 

diff --git a/website/docs/models/Base1DView.md b/website/docs/models/Base1DView.md
@@ -231,7 +231,7 @@ zoomIn: () => void
 
 ```js
 // type signature
-zoomTo: (newBpPerPx: number, offset?: number) => number
+zoomTo: (bpPerPx: number, offset?: number) => number
 ```
 
 #### action: scrollTo

diff --git a/website/docs/models/BaseLinearDisplay.md b/website/docs/models/BaseLinearDisplay.md
@@ -299,7 +299,7 @@ clearRegionStats: () => void
 
 ```js
 // type signature
-setHeight: (displayHeight: number) => any
+setHeight: (displayHeight: number) => number
 ```
 
 #### action: resizeHeight

diff --git a/website/docs/models/Dotplot1DView.md b/website/docs/models/Dotplot1DView.md
@@ -43,6 +43,27 @@ number
 number
 ```
 
+#### getter: minBpPerPx
+
+```js
+// type
+number
+```
+
+#### getter: maxOffset
+
+```js
+// type
+number
+```
+
+#### getter: minOffset
+
+```js
+// type
+number
+```
+
 ### Dotplot1DView - Actions
 
 #### action: setScaleFactor

diff --git a/website/docs/models/DotplotView.md b/website/docs/models/DotplotView.md
@@ -138,9 +138,37 @@ vview: types.optional(DotplotVView, {})
 
 ```js
 // type signature
-string
+IOptionalIType<ISimpleType<string>, [undefined]>
+// code
+cursorMode: types.optional(
+          types.string,
+          () => localStorageGetItem('dotplot-cursorMode') || 'crosshair',
+        )
+```
+
+#### property: wheelMode
+
+```js
+// type signature
+IOptionalIType<ISimpleType<string>, [undefined]>
+// code
+wheelMode: types.optional(
+          types.string,
+          () => localStorageGetItem('dotplot-wheelMode') || 'zoom',
+        )
+```
+
+#### property: showPanButtons
+
+```js
+// type signature
+IOptionalIType<ISimpleType<boolean>, [undefined]>
 // code
-cursorMode: 'crosshair'
+showPanButtons: types.optional(types.boolean, () =>
+          Boolean(
+            JSON.parse(localStorageGetItem('dotplot-showPanbuttons') || 'true'),
+          ),
+        )
 ```
 
 #### property: tracks
@@ -263,6 +291,20 @@ menuItems: () => ({ label: string; onClick: () => void; icon: OverridableCompone
 
 ### DotplotView - Actions
 
+#### action: setShowPanButtons
+
+```js
+// type signature
+setShowPanButtons: (flag: boolean) => void
+```
+
+#### action: setWheelMode
+
+```js
+// type signature
+setWheelMode: (str: string) => void
+```
+
 #### action: setCursorMode
 
 ```js

diff --git a/website/docs/models/JBrowseDesktopSessionModel.md b/website/docs/models/JBrowseDesktopSessionModel.md
@@ -180,28 +180,28 @@ any
 
 ```js
 // type
-any
+{ [x: string]: any; } & NonEmptyObject & { setSubschema(slotName: string, data: unknown): any; } & IStateTreeNode<AnyConfigurationSchemaType>
 ```
 
 #### getter: assemblies
 
 ```js
 // type
-any
+({ [x: string]: any; } & NonEmptyObject & { setSubschema(slotName: string, data: unknown): any; } & IStateTreeNode<AnyConfigurationSchemaType>)[]
 ```
 
 #### getter: assemblyNames
 
 ```js
 // type
-any
+string[]
 ```
 
 #### getter: tracks
 
 ```js
 // type
-any
+({ [x: string]: any; } & NonEmptyObject & { setSubschema(slotName: string, data: unknown): any; } & IStateTreeNode<AnyConfigurationSchemaType>)[]
 ```
 
 #### getter: textSearchManager
@@ -520,12 +520,8 @@ addViewFromAnotherView: (
 
 ```js
 // type signature
-addWidget: (
-  typeName: string,
-  id: string,
-  initialState?: {},
-  configuration?: { type: string },
-) => any
+addWidget: (typeName: string, id: string, initialState?: {}, conf?: unknown) =>
+  any
 ```
 
 #### action: showWidget

diff --git a/website/docs/models/JBrowseReactCGVSessionModel.md b/website/docs/models/JBrowseReactCGVSessionModel.md
@@ -268,12 +268,8 @@ removeView: () => void
 
 ```js
 // type signature
-addWidget: (
-  typeName: string,
-  id: string,
-  initialState?: {},
-  configuration?: { type: string },
-) => any
+addWidget: (typeName: string, id: string, initialState?: {}, conf?: unknown) =>
+  any
 ```
 
 #### action: showWidget

diff --git a/website/docs/models/JBrowseReactLGVSessionModel.md b/website/docs/models/JBrowseReactLGVSessionModel.md
@@ -305,12 +305,8 @@ addView: (typeName: string, initialState?: {}) => { id: string; displayName: str
 
 ```js
 // type signature
-addWidget: (
-  typeName: string,
-  id: string,
-  initialState?: {},
-  configuration?: { type: string },
-) => any
+addWidget: (typeName: string, id: string, initialState?: {}, conf?: unknown) =>
+  any
 ```
 
 #### action: showWidget

diff --git a/website/docs/models/JBrowseWebSessionModel.md b/website/docs/models/JBrowseWebSessionModel.md
@@ -584,12 +584,8 @@ addViewFromAnotherView: (
 
 ```js
 // type signature
-addWidget: (
-  typeName: string,
-  id: string,
-  initialState?: {},
-  configuration?: { type: string },
-) => any
+addWidget: (typeName: string, id: string, initialState?: {}, conf?: unknown) =>
+  any
 ```
 
 #### action: showWidget

diff --git a/website/docs/models/LinearGenomeView.md b/website/docs/models/LinearGenomeView.md
@@ -259,7 +259,7 @@ number
 
 ```js
 // type
-any
+number
 ```
 
 #### getter: trackHeightsWithResizeHandles
@@ -616,7 +616,7 @@ scrollTo: (offsetPx: number) => number
 
 ```js
 // type signature
-zoomTo: (bpPerPx: number) => number
+zoomTo: (bpPerPx: number, offset?: number, centerAtOffset?: boolean) => number
 ```
 
 #### action: setOffsets