diff --git a/plugins/sv-inspector/src/SvInspectorView/models/SvInspectorView.ts b/plugins/sv-inspector/src/SvInspectorView/models/SvInspectorView.ts index 543820bb18..1f13256e3f 100644 --- 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 index 564e7a95db..b5e84586c0 100644 --- 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 index 6ecf3d968a..b1aadc8592 100644 --- 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 index e701c70a98..e5893ce4d4 100644 --- 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 index 9ea9669d39..2e31de1ad2 100644 --- 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, [undefined]> +// code +cursorMode: types.optional( + types.string, + () => localStorageGetItem('dotplot-cursorMode') || 'crosshair', + ) +``` + +#### property: wheelMode + +```js +// type signature +IOptionalIType, [undefined]> +// code +wheelMode: types.optional( + types.string, + () => localStorageGetItem('dotplot-wheelMode') || 'zoom', + ) +``` + +#### property: showPanButtons + +```js +// type signature +IOptionalIType, [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 index 353c300bea..90e7b7f84a 100644 --- 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 ``` #### getter: assemblies ```js // type -any +({ [x: string]: any; } & NonEmptyObject & { setSubschema(slotName: string, data: unknown): any; } & IStateTreeNode)[] ``` #### getter: assemblyNames ```js // type -any +string[] ``` #### getter: tracks ```js // type -any +({ [x: string]: any; } & NonEmptyObject & { setSubschema(slotName: string, data: unknown): any; } & IStateTreeNode)[] ``` #### 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 index 185b8ef1ed..87cd14cef5 100644 --- 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 index 59ba2b0e03..2faa55b26d 100644 --- 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 index 935c279bdc..d01fcc769d 100644 --- 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 index e19d5ffd04..549e0b1958 100644 --- 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 diff --git a/website/docs/models/SvInspectorView.md b/website/docs/models/SvInspectorView.md new file mode 100644 index 0000000000..9f4cc2c50f --- /dev/null +++ b/website/docs/models/SvInspectorView.md @@ -0,0 +1,214 @@ +--- +id: svinspectorview +title: SvInspectorView +toplevel: true +--- + +Note: this document is automatically generated from mobx-state-tree objects in +our source code. See +[Core concepts and intro to pluggable elements](/docs/developer_guide/) for more +info + +## Source file + +[plugins/sv-inspector/src/SvInspectorView/models/SvInspectorView.ts](https://github.com/GMOD/jbrowse-components/blob/main/plugins/sv-inspector/src/SvInspectorView/models/SvInspectorView.ts) + +## Docs + +combination of a spreadsheetview and a circularview + +### SvInspectorView - Properties + +#### property: id + +```js +// type signature +IOptionalIType, [undefined]> +// code +id: ElementId +``` + +#### property: type + +```js +// type signature +ISimpleType<"SvInspectorView"> +// code +type: types.literal('SvInspectorView') +``` + +#### property: height + +```js +// type signature +IOptionalIType, [undefined]> +// code +height: types.optional( + types.refinement( + 'SvInspectorViewHeight', + types.number, + n => n >= minHeight, + ), + defaultHeight, + ) +``` + +#### property: onlyDisplayRelevantRegionsInCircularView + +```js +// type signature +false +// code +onlyDisplayRelevantRegionsInCircularView: false +``` + +#### property: mode + +switch specifying whether we are showing the import wizard or the spreadsheet in +our viewing area + +```js +// type signature +IOptionalIType, [undefined]> +// code +mode: types.optional( + types.enumeration('SvInspectorViewMode', ['import', 'display']), + 'import', + ) +``` + +#### property: spreadsheetView + +```js +// type signature +IOptionalIType, [undefined]>; displayName: IMaybe>; minimized: IType; } & { ...; }, { ...; } & ... 4 more ... & { ...; }, _NotCustomized, _NotCustomized>, [...]> +// code +spreadsheetView: types.optional(SpreadsheetModel, () => + SpreadsheetModel.create({ + type: 'SpreadsheetView', + hideViewControls: true, + hideVerticalResizeHandle: true, + }), + ) +``` + +#### property: circularView + +```js +// type signature +IOptionalIType, [undefined]>; displayName: IMaybe>; minimized: IType; } & { ...; }, { ...; } & ... 7 more ... & { ...; }, _NotCustomized, _NotCustomized>, [...]> +// code +circularView: types.optional(CircularModel, () => + CircularModel.create({ + type: 'CircularView', + hideVerticalResizeHandle: true, + hideTrackSelectorButton: true, + disableImportForm: true, + }), + ) +``` + +### SvInspectorView - Getters + +#### getter: selectedRows + +```js +// type +any +``` + +#### getter: assemblyName + +```js +// type +any +``` + +#### getter: showCircularView + +```js +// type +boolean +``` + +#### getter: featuresAdapterConfigSnapshot + +```js +// type +{ + type: string + features: any +} +``` + +#### getter: featureRefNames + +```js +// type +any[] +``` + +#### getter: featuresCircularTrackConfiguration + +```js +// type +{ type: string; trackId: string; name: string; adapter: any; assemblyNames: any[]; displays: { type: string; displayId: string; onChordClick: string; renderer: { type: string; }; }[]; } +``` + +### SvInspectorView - Actions + +#### action: setWidth + +```js +// type signature +setWidth: (newWidth: number) => void +``` + +#### action: setHeight + +```js +// type signature +setHeight: (newHeight: number) => number +``` + +#### action: setImportMode + +```js +// type signature +setImportMode: () => void +``` + +#### action: setDisplayMode + +```js +// type signature +setDisplayMode: () => void +``` + +#### action: closeView + +```js +// type signature +closeView: () => void +``` + +#### action: setDisplayedRegions + +```js +// type signature +setDisplayedRegions: (regions: Region[]) => void +``` + +#### action: setOnlyDisplayRelevantRegionsInCircularView + +```js +// type signature +setOnlyDisplayRelevantRegionsInCircularView: (val: boolean) => void +``` + +#### action: resizeHeight + +```js +// type signature +resizeHeight: (distance: number) => number +```