SvInspectorView
Note: this document is automatically generated from mobx-state-tree objects in our source code. See Core concepts and intro to pluggable elements for more info
Source file
plugins/sv-inspector/src/SvInspectorView/models/SvInspectorView.ts
does not extend, but is a combination of a
extends
SvInspectorView - Properties
property: id
// type signature
IOptionalIType<ISimpleType<string>, [undefined]>
// code
id: ElementId
property: type
// type signature
ISimpleType<"SvInspectorView">
// code
type: types.literal('SvInspectorView')
property: height
// type signature
IOptionalIType<ISimpleType<number>, [undefined]>
// code
height: types.optional(
types.refinement(
'SvInspectorViewHeight',
types.number,
n => n >= minHeight,
),
defaultHeight,
)
property: onlyDisplayRelevantRegionsInCircularView
// type signature
false
// code
onlyDisplayRelevantRegionsInCircularView: false
property: mode
switch specifying whether we are showing the import wizard or the spreadsheet in our viewing area
// type signature
IOptionalIType<ISimpleType<string>, [undefined]>
// code
mode: types.optional(
types.enumeration('SvInspectorViewMode', ['import', 'display']),
'import',
)
property: spreadsheetView
// type signature
IOptionalIType<IModelType<{ id: IOptionalIType<ISimpleType<string>, [undefined]>; displayName: IMaybe<ISimpleType<string>>; minimized: IType<boolean, boolean, boolean>; } & { ...; }, { ...; } & ... 5 more ... & { ...; }, _NotCustomized, _NotCustomized>, [...]>
// code
spreadsheetView: types.optional(SpreadsheetModel, () =>
SpreadsheetModel.create({
type: 'SpreadsheetView',
hideVerticalResizeHandle: true,
}),
)
property: circularView
// type signature
IOptionalIType<IModelType<{ id: IOptionalIType<ISimpleType<string>, [undefined]>; displayName: IMaybe<ISimpleType<string>>; minimized: IType<boolean, boolean, boolean>; } & { ...; }, { ...; } & ... 7 more ... & { ...; }, _NotCustomized, _NotCustomized>, [...]>
// code
circularView: types.optional(CircularModel, () =>
CircularModel.create({
type: 'CircularView',
hideVerticalResizeHandle: true,
hideTrackSelectorButton: true,
disableImportForm: true,
}),
)
SvInspectorView - Getters
getter: selectedRows
// type
any
getter: assemblyName
// type
any
getter: showCircularView
// type
boolean
getter: features
// type
any
getter: featuresAdapterConfigSnapshot
// type
{
type: string
features: any
}
getter: featureRefNames
// type
any[]
getter: featuresCircularTrackConfiguration
// type
{ type: string; trackId: string; name: string; adapter: any; assemblyNames: any[]; displays: { type: string; displayId: string; onChordClick: string; renderer: { type: string; }; }[]; }
SvInspectorView - Methods
method: menuItems
// type signature
menuItems: () => { label: string; onClick: () => void; icon: OverridableComponent<SvgIconTypeMap<{}, "svg">> & { muiName: string; }; }[]
SvInspectorView - Actions
action: setWidth
// type signature
setWidth: (newWidth: number) => void
action: setHeight
// type signature
setHeight: (newHeight: number) => number
action: setImportMode
// type signature
setImportMode: () => void
action: setDisplayMode
// type signature
setDisplayMode: () => void
action: closeView
// type signature
closeView: () => void
action: setDisplayedRegions
// type signature
setDisplayedRegions: (regions: Region[]) => void
action: setOnlyDisplayRelevantRegionsInCircularView
// type signature
setOnlyDisplayRelevantRegionsInCircularView: (val: boolean) => void
action: resizeHeight
// type signature
resizeHeight: (distance: number) => number