Skip to content

Commit

Permalink
[update docs] Update autogen docs
Browse files Browse the repository at this point in the history
  • Loading branch information
cmdcolin committed Oct 20, 2023
1 parent 0167cbc commit 83bdd1c
Show file tree
Hide file tree
Showing 5 changed files with 155 additions and 0 deletions.
11 changes: 11 additions & 0 deletions website/docs/config/ArcRenderer.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,3 +67,14 @@ caption: {
contextVariable: ['feature'],
}
```

#### slot: displayMode

```js
displayMode: {
type: 'enum',
defaultValue: 'arcs',
model: types.enumeration('DisplayMode', ['arcs', 'semicircles']),
description: 'render semi-circles instead of arcs',
}
```
18 changes: 18 additions & 0 deletions website/docs/config/GCContentAdapter.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,3 +20,21 @@ sequenceAdapter: {
defaultValue: null,
}
```

#### slot: windowSize

```js
windowSize: {
type: 'number',
defaultValue: 100,
}
```

#### slot: windowDelta

```js
windowDelta: {
type: 'number',
defaultValue: 100,
}
```
2 changes: 2 additions & 0 deletions website/docs/config/LinearGCContentDisplay.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ source code. See [Config guide](/docs/config_guide) for more info

[plugins/gccontent/src/LinearGCContentDisplay/config.ts](https://github.com/GMOD/jbrowse-components/blob/main/plugins/gccontent/src/LinearGCContentDisplay/config.ts)

extends LinearWiggleDisplay

### LinearGCContentDisplay - Derives from

```js
Expand Down
106 changes: 106 additions & 0 deletions website/docs/models/LinearArcDisplay.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,106 @@
---
id: lineararcdisplay
title: LinearArcDisplay
---

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/arc/src/LinearArcDisplay/model.ts](https://github.com/GMOD/jbrowse-components/blob/main/plugins/arc/src/LinearArcDisplay/model.ts)

extends BaseLinearDisplay

### LinearArcDisplay - Properties

#### property: type

```js
// type signature
ISimpleType<"LinearArcDisplay">
// code
type: types.literal('LinearArcDisplay')
```

#### property: configuration

```js
// type signature
AnyConfigurationSchemaType
// code
configuration: ConfigurationReference(configSchema)
```

#### property: displayMode

```js
// type signature
IMaybe<ISimpleType<string>>
// code
displayMode: types.maybe(types.string)
```

### LinearArcDisplay - Getters

#### getter: blockType

```js
// type
string
```

#### getter: renderDelay

```js
// type
number
```

#### getter: rendererTypeName

```js
// type
any
```

#### getter: displayModeSetting

```js
// type
any
```

#### getter: rendererConfig

```js
// type
{ [x: string]: any; } & NonEmptyObject & { setSubschema(slotName: string, data: unknown): any; } & IStateTreeNode<AnyConfigurationSchemaType>
```

### LinearArcDisplay - Methods

#### method: renderProps

```js
// type signature
renderProps: () => any
```

#### method: trackMenuItems

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

### LinearArcDisplay - Actions

#### action: setDisplayMode

```js
// type signature
setDisplayMode: (flag: string) => void
```
18 changes: 18 additions & 0 deletions website/docs/models/LinearGCContentDisplay.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,24 @@ ISimpleType<"LinearGCContentDisplay">
type: types.literal('LinearGCContentDisplay')
```

#### property: windowSize

```js
// type signature
IMaybe<ISimpleType<number>>
// code
windowSize: types.maybe(types.number)
```

#### property: windowDelta

```js
// type signature
IMaybe<ISimpleType<number>>
// code
windowDelta: types.maybe(types.number)
```

### LinearGCContentDisplay - Methods

#### method: renderProps
Expand Down

0 comments on commit 83bdd1c

Please sign in to comment.