Skip to content

Commit 930c4b4

Browse files
committed
Fix broken links in docs
1 parent b8dbc74 commit 930c4b4

File tree

2 files changed

+98
-5
lines changed

2 files changed

+98
-5
lines changed

plugins/alignments/src/shared/LinearReadDisplayBaseMixin.ts

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,14 @@ import { NonBlockCanvasDisplayMixin } from '@jbrowse/plugin-linear-genome-view'
44
import type { ChainData, ColorBy, FilterBy } from './types.ts'
55

66
/**
7+
* #stateModel LinearReadDisplayBaseMixin
78
* Base mixin for all LinearRead displays (Cloud, Stack, Arcs)
8-
* Contains common volatile state, views, and actions shared across all three display types.
9-
* Composes with NonBlockCanvasDisplayMixin for the shared non-block canvas display state.
9+
* Contains common volatile state, views, and actions shared across all three
10+
* display types. Composes with NonBlockCanvasDisplayMixin for the shared
11+
* non-block canvas display state.
1012
*
11-
* Note: colorBy, filterBy views and reload action must be defined in the display
12-
* model since they need access to `configuration` (for getConf) and `error`
13-
* (from BaseDisplay) which are not available in this mixin's type context.
13+
* extends
14+
* - [NonBlockCanvasDisplayMixin](../nonblockcanvasdisplaymixin)
1415
*/
1516
export function LinearReadDisplayBaseMixin() {
1617
return types.compose(
Lines changed: 92 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
1+
---
2+
id: linearreaddisplaybasemixin
3+
title: LinearReadDisplayBaseMixin
4+
---
5+
6+
Note: this document is automatically generated from @jbrowse/mobx-state-tree
7+
objects in our source code. See
8+
[Core concepts and intro to pluggable elements](/docs/developer_guide/) for more
9+
info
10+
11+
Also note: this document represents the state model API for the current released
12+
version of jbrowse. If you are not using the current version, please cross
13+
reference the markdown files in our repo of the checked out git tag
14+
15+
## Links
16+
17+
[Source code](https://github.com/GMOD/jbrowse-components/blob/main/plugins/alignments/src/shared/LinearReadDisplayBaseMixin.ts)
18+
19+
[GitHub page](https://github.com/GMOD/jbrowse-components/tree/main/website/docs/models/LinearReadDisplayBaseMixin.md)
20+
21+
## Docs
22+
23+
Base mixin for all LinearRead displays (Cloud, Stack, Arcs) Contains common
24+
volatile state, views, and actions shared across all three display types.
25+
Composes with NonBlockCanvasDisplayMixin for the shared non-block canvas display
26+
state.
27+
28+
extends
29+
30+
- [NonBlockCanvasDisplayMixin](../nonblockcanvasdisplaymixin)
31+
32+
### LinearReadDisplayBaseMixin - Properties
33+
34+
#### property: filterBySetting
35+
36+
Filter settings override (if set, overrides configuration)
37+
38+
```js
39+
// type signature
40+
IType<FilterBy, FilterBy, FilterBy>
41+
// code
42+
filterBySetting: types.frozen<FilterBy | undefined>()
43+
```
44+
45+
#### property: colorBySetting
46+
47+
Color scheme settings override (if set, overrides configuration)
48+
49+
```js
50+
// type signature
51+
IType<ColorBy, ColorBy, ColorBy>
52+
// code
53+
colorBySetting: types.frozen<ColorBy | undefined>()
54+
```
55+
56+
### LinearReadDisplayBaseMixin - Actions
57+
58+
#### action: setLastDrawnBpPerPx
59+
60+
Update the last drawn bp per pixel value
61+
62+
```js
63+
// type signature
64+
setLastDrawnBpPerPx: (n: number) => void
65+
```
66+
67+
#### action: setColorScheme
68+
69+
Set the color scheme override
70+
71+
```js
72+
// type signature
73+
setColorScheme: (colorBy: { type: string; }) => void
74+
```
75+
76+
#### action: setChainData
77+
78+
Set the chain data to render
79+
80+
```js
81+
// type signature
82+
setChainData: (args: ChainData) => void
83+
```
84+
85+
#### action: setFilterBy
86+
87+
Set the filter override
88+
89+
```js
90+
// type signature
91+
setFilterBy: (filter: FilterBy) => void
92+
```

0 commit comments

Comments
 (0)