Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
cmdcolin committed Mar 21, 2024
1 parent 158fef8 commit b7bc66c
Show file tree
Hide file tree
Showing 17 changed files with 941 additions and 444 deletions.
2 changes: 1 addition & 1 deletion lib/apidocs/DataModel.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ our source code.

### Source file

[src/DataModel.ts](https://github.com/GMOD/react-msaview/blob/main/lib/src/DataModel.ts)
[src/model/DataModel.ts](https://github.com/GMOD/react-msaview/blob/main/lib/src/model/DataModel.ts)

the data stored for the model. this is sometimes temporary in the case that
e.g. msaFilehandle is available on the parent model, because then the msa
Expand Down
2 changes: 1 addition & 1 deletion lib/apidocs/DialogQueueSessionMixin.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ our source code.

### Source file

[src/DialogQueue.ts](https://github.com/GMOD/react-msaview/blob/main/lib/src/DialogQueue.ts)
[src/model/DialogQueue.ts](https://github.com/GMOD/react-msaview/blob/main/lib/src/model/DialogQueue.ts)



Expand Down
64 changes: 64 additions & 0 deletions lib/apidocs/MSAModel.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
---
id: msamodel
title: MSAModel
---

Note: this document is automatically generated from mobx-state-tree objects in
our source code.

### Source file

[src/model/msaModel.ts](https://github.com/GMOD/react-msaview/blob/main/lib/src/model/msaModel.ts)



### MSAModel - Properties
#### property: bgColor

draw MSA tiles with a background color

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

#### property: colorSchemeName

default color scheme name

```js
// type signature
string
// code
colorSchemeName: 'maeditor'
```








### MSAModel - Actions
#### action: setBgColor



```js
// type signature
setBgColor: (arg: boolean) => void
```

#### action: setColorSchemeName

set color scheme name

```js
// type signature
setColorSchemeName: (name: string) => void
```


Loading

0 comments on commit b7bc66c

Please sign in to comment.