Skip to content

Commit

Permalink
Update auto-generated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
cmdcolin committed Jan 8, 2023
1 parent e7f79a4 commit 85defcc
Show file tree
Hide file tree
Showing 10 changed files with 112 additions and 84 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@ import PluginManager from '@jbrowse/core/PluginManager'
import CropFreeIcon from '@mui/icons-material/CropFree'
import LinkIcon from '@mui/icons-material/Link'
import LinkOffIcon from '@mui/icons-material/LinkOff'
import VisibilityIcon from '@mui/icons-material/Visibility'
import { Curves } from './components/Icons'

// locals
import baseModel from '../LinearComparativeView/model'
import VisibilityIcon from '@mui/icons-material/Visibility'

/**
* #stateModel LinearSyntenyView
Expand Down
14 changes: 2 additions & 12 deletions website/docs/config/LinearComparativeDisplay.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,16 +9,6 @@ source code. See [Config guide](/docs/config_guide) for more info

## Docs

### LinearComparativeDisplay - Slots
### LinearComparativeDisplay - Identifier

#### slot: renderer

```js
renderer: pluginManager.pluggableConfigSchemaType('renderer')
```

## LinearComparativeDisplay - Derives from

```js
baseConfiguration: baseLinearDisplayConfigSchema
```
#### slot: explicitIdentifier
10 changes: 1 addition & 9 deletions website/docs/config/LinearSyntenyDisplay.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,14 +22,6 @@ trackIds: {
}
```

#### slot: renderer

```js
renderer: types.optional(pluginManager.pluggableConfigSchemaType('renderer'), {
type: 'LinearSyntenyRenderer',
})
```

#### slot: middle

currently unused
Expand All @@ -40,7 +32,7 @@ middle: { type: 'boolean', defaultValue: true }

## LinearSyntenyDisplay - Derives from

this refers to the base linear comparative display
this refers to the LinearComparativeDisplay

```js
baseConfiguration: baseConfigFactory(pluginManager)
Expand Down
22 changes: 0 additions & 22 deletions website/docs/config/LinearSyntenyRenderer.md

This file was deleted.

7 changes: 7 additions & 0 deletions website/docs/models/DotplotView.md
Original file line number Diff line number Diff line change
Expand Up @@ -421,3 +421,10 @@ squareView: () => void
// type signature
squareViewProportional: () => void
```
#### action: showAllRegions
```js
// type signature
showAllRegions: () => void
```
4 changes: 0 additions & 4 deletions website/docs/models/JBrowseReactCGVSessionModel.md
Original file line number Diff line number Diff line change
Expand Up @@ -262,8 +262,6 @@ removeView: () => void

#### action: addWidget

does nothing

```js
// type signature
addWidget: (
Expand All @@ -276,8 +274,6 @@ addWidget: (

#### action: showWidget

does nothing

```js
// type signature
showWidget: (widget: any) => void
Expand Down
9 changes: 1 addition & 8 deletions website/docs/models/LinearComparativeDisplay.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,13 +42,6 @@ height: 100

### LinearComparativeDisplay - Getters

#### getter: rendererTypeName

```js
// type
any
```

#### getter: renderProps

```js
Expand Down Expand Up @@ -82,7 +75,7 @@ controlled by a reaction

```js
// type signature
setRendered: (args?: { data: unknown; reactElement: React.ReactElement; renderingComponent: React.Component; }) => void
setRendered: (args?: { features: Feature[]; }) => void
```

#### action: setError
Expand Down
26 changes: 10 additions & 16 deletions website/docs/models/LinearComparativeView.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,15 +31,6 @@ ISimpleType<"LinearComparativeView">
type: types.literal('LinearComparativeView')
```

#### property: height

```js
// type signature
number
// code
height: defaultHeight
```

#### property: trackSelectorType

```js
Expand Down Expand Up @@ -156,6 +147,16 @@ any[]

### LinearComparativeView - Methods

#### method: headerMenuItems

includes a subset of view menu options because the full list is a little
overwhelming. overridden by subclasses

```js
// type signature
headerMenuItems: () => MenuItem[]
```

#### method: menuItems

```js
Expand All @@ -179,13 +180,6 @@ rubberBandMenuItems: () => { label: string; onClick: () => void; }[]
setWidth: (newWidth: number) => void
```

#### action: setHeight

```js
// type signature
setHeight: (newHeight: number) => void
```

#### action: setViews

```js
Expand Down
72 changes: 63 additions & 9 deletions website/docs/models/LinearSyntenyDisplay.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,34 +35,88 @@ configuration: ConfigurationReference(configSchema)

### LinearSyntenyDisplay - Getters

#### getter: rendererTypeName
#### getter: adapterConfig

```js
// type
any
```

#### getter: adapterConfig
#### getter: trackIds

```js
// type
any
string[]
```

#### getter: trackIds
#### getter: numFeats

unused
```js
// type
number
```

#### getter: featMap

```js
// type
string[]
{ [k: string]: FeatPos; }
```

### LinearSyntenyDisplay - Actions

#### action: setFeatPositions

```js
// type signature
setFeatPositions: (arg: FeatPos[]) => void
```

#### action: setMainCanvasRef

```js
// type signature
setMainCanvasRef: (ref: HTMLCanvasElement) => void
```

#### action: setClickMapCanvasRef

```js
// type signature
setClickMapCanvasRef: (ref: HTMLCanvasElement) => void
```

#### action: setCigarClickMapCanvasRef

```js
// type signature
setCigarClickMapCanvasRef: (ref: HTMLCanvasElement) => void
```

### LinearSyntenyDisplay - Methods
#### action: setMouseoverCanvasRef

```js
// type signature
setMouseoverCanvasRef: (ref: HTMLCanvasElement) => void
```

#### action: setMouseoverId

```js
// type signature
setMouseoverId: (arg: number) => void
```

#### action: setCigarMouseoverId

```js
// type signature
setCigarMouseoverId: (arg: number) => void
```

#### method: renderProps
#### action: setClickId

```js
// type signature
renderProps: () => { rpcDriverName: string; displayModel: { id: string; type: never; rpcDriverName: string; configuration: any; height: number; } & NonEmptyObject & { rendererTypeName: string; error: unknown; } & ... 6 more ... & IStateTreeNode<...>; config: any; width: number; height: number; }
setClickId: (arg: number) => void
```
30 changes: 27 additions & 3 deletions website/docs/models/LinearSyntenyView.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,15 @@ ISimpleType<"LinearSyntenyView">
type: types.literal('LinearSyntenyView')
```

#### property: /

```js
// type signature
true
// code
drawCIGAR: true
```

#### property: drawCurves

```js
Expand All @@ -35,13 +44,14 @@ drawCurves: false

### LinearSyntenyView - Methods

#### method: menuItems
#### method: headerMenuItems

adds functions to draw curves and square the view
includes a subset of view menu options because the full list is a little
overwhelming

```js
// type signature
menuItems: () => (MenuDivider | MenuSubHeader | NormalMenuItem | CheckboxMenuItem | RadioMenuItem | SubMenuItem | { ...; })[]
headerMenuItems: () => (MenuDivider | MenuSubHeader | NormalMenuItem | CheckboxMenuItem | RadioMenuItem | SubMenuItem | { ...; } | { ...; } | { ...; })[]
```

### LinearSyntenyView - Actions
Expand All @@ -52,3 +62,17 @@ menuItems: () => (MenuDivider | MenuSubHeader | NormalMenuItem | CheckboxMenuIte
// type signature
toggleCurves: () => void
```

#### action: toggleCIGAR

```js
// type signature
toggleCIGAR: () => void
```

#### action: showAllRegions

```js
// type signature
showAllRegions: () => void
```

0 comments on commit 85defcc

Please sign in to comment.