[update docs] Autogen docs

GMOD · Feb 13, 2025 · 2e5ef84 · 2e5ef84
1 parent 493f202
commit 2e5ef84
Show file tree

Hide file tree

Showing 8 changed files with 55 additions and 10 deletions.
diff --git a/website/docs/config/GtfAdapter.md b/website/docs/config/GtfAdapter.md
@@ -28,3 +28,12 @@ gtfLocation: {
       defaultValue: { uri: '/path/to/my.gtf', locationType: 'UriLocation' },
     }
 ```
+
+#### slot: aggregateField
+
+```js
+aggregateField: {
+      type: 'string',
+      defaultValue: 'gene_name',
+    }
+```
diff --git a/website/docs/config/LinearSyntenyDisplay.md b/website/docs/config/LinearSyntenyDisplay.md
@@ -36,7 +36,10 @@ trackIds: {
 currently unused
 
 ```js
-middle: { type: 'boolean', defaultValue: true }
+middle: {
+        type: 'boolean',
+        defaultValue: true,
+      }
 ```
 
 ### LinearSyntenyDisplay - Derives from

diff --git a/website/docs/config/WiggleRenderer.md b/website/docs/config/WiggleRenderer.md
@@ -29,6 +29,7 @@ color: {
       type: 'color',
       description: 'the color of track, overrides posColor and negColor',
       defaultValue: '#f0f',
+      contextVariable: ['feature'],
     }
 ```
 
@@ -39,6 +40,7 @@ posColor: {
       type: 'color',
       description: 'the color to use when the score is positive',
       defaultValue: 'blue',
+      contextVariable: ['feature'],
     }
 ```
 
@@ -49,6 +51,7 @@ negColor: {
       type: 'color',
       description: 'the color to use when the score is negative',
       defaultValue: 'red',
+      contextVariable: ['feature'],
     }
 ```
 

diff --git a/website/docs/models/BaseTrackModel.md b/website/docs/models/BaseTrackModel.md
@@ -96,6 +96,13 @@ any
 any
 ```
 
+#### getter: adapterConfig
+
+```js
+// type
+any
+```
+
 #### getter: adapterType
 
 ```js

diff --git a/website/docs/models/JobsListModel.md b/website/docs/models/JobsListModel.md
@@ -96,21 +96,21 @@ removeJob: (jobName: string) => { name: string; statusMessage: string; progressP
 
 ```js
 // type signature
-addFinishedJob: (job: NewJob) => IMSTArray<IModelType<{ name: ISimpleType<string>; statusMessage: IMaybe<ISimpleType<string>>; progressPct: ISimpleType<number>; }, { ...; } & { ...; }, _NotCustomized, _NotCustomized>> & IStateTreeNode<...>
+addFinishedJob: (job: NewJob) => { name: string; statusMessage: string; progressPct: number; } & NonEmptyObject & { cancelCallback(): void; } & { setCancelCallback(cancelCallback: () => void): void; setStatusMessage(message?: string): void; setProgressPct(pct: number): void; } & IStateTreeNode<...>
 ```
 
 #### action: addQueuedJob
 
 ```js
 // type signature
-addQueuedJob: (job: NewJob) => IMSTArray<IModelType<{ name: ISimpleType<string>; statusMessage: IMaybe<ISimpleType<string>>; progressPct: ISimpleType<number>; }, { ...; } & { ...; }, _NotCustomized, _NotCustomized>> & IStateTreeNode<...>
+addQueuedJob: (job: NewJob) => { name: string; statusMessage: string; progressPct: number; } & NonEmptyObject & { cancelCallback(): void; } & { setCancelCallback(cancelCallback: () => void): void; setStatusMessage(message?: string): void; setProgressPct(pct: number): void; } & IStateTreeNode<...>
 ```
 
 #### action: addAbortedJob
 
 ```js
 // type signature
-addAbortedJob: (job: NewJob) => IMSTArray<IModelType<{ name: ISimpleType<string>; statusMessage: IMaybe<ISimpleType<string>>; progressPct: ISimpleType<number>; }, { ...; } & { ...; }, _NotCustomized, _NotCustomized>> & IStateTreeNode<...>
+addAbortedJob: (job: NewJob) => { name: string; statusMessage: string; progressPct: number; } & NonEmptyObject & { cancelCallback(): void; } & { setCancelCallback(cancelCallback: () => void): void; setStatusMessage(message?: string): void; setProgressPct(pct: number): void; } & IStateTreeNode<...>
 ```
 
 #### action: removeQueuedJob

diff --git a/website/docs/models/LinearSNPCoverageDisplay.md b/website/docs/models/LinearSNPCoverageDisplay.md
@@ -178,7 +178,7 @@ LazyExoticComponent<(props: { model: { featureUnderMouse?: Feature; }; height: n
 string
 ```
 
-#### getter: needsScalebar
+#### getter: graphType
 
 ```js
 // type

diff --git a/website/docs/models/LinearWiggleDisplay.md b/website/docs/models/LinearWiggleDisplay.md
@@ -35,6 +35,15 @@ ISimpleType<"LinearWiggleDisplay">
 type: types.literal('LinearWiggleDisplay')
 ```
 
+#### property: invertedSetting
+
+```js
+// type signature
+IMaybe<ISimpleType<boolean>>
+// code
+invertedSetting: types.maybe(types.boolean)
+```
+
 ### LinearWiggleDisplay - Getters
 
 #### getter: TooltipComponent
@@ -60,18 +69,25 @@ unused currently
 boolean
 ```
 
-#### getter: ticks
+#### getter: graphType
 
 ```js
 // type
-{ range: number[]; values: number[]; format: (d: NumberValue) => string; position: ScaleLinear<number, number, never> | ScaleQuantize<number, never>; }
+boolean
 ```
 
-#### getter: needsScalebar
+#### getter: inverted
 
 ```js
 // type
-boolean
+any
+```
+
+#### getter: ticks
+
+```js
+// type
+{ range: number[]; values: number[]; format: (d: NumberValue) => string; position: ScaleLinear<number, number, never> | ScaleQuantize<number, never>; }
 ```
 
 #### getter: fillSetting
@@ -113,6 +129,13 @@ trackMenuItems: () => (MenuDivider | MenuSubHeader | NormalMenuItem | CheckboxMe
 
 ### LinearWiggleDisplay - Actions
 
+#### action: setInverted
+
+```js
+// type signature
+setInverted: (arg: boolean) => void
+```
+
 #### action: renderSvg
 
 ```js

diff --git a/website/docs/models/MultiLinearWiggleDisplay.md b/website/docs/models/MultiLinearWiggleDisplay.md
@@ -67,7 +67,7 @@ React.ComponentType<any>
 string
 ```
 
-#### getter: needsScalebar
+#### getter: graphType
 
 ```js
 // type
-Original file line number
+Diff line change
@@ Expand Up / @@ -96,6 +96,13 @@ any @@
     any
     ```
+    #### getter: adapterConfig
+    ```js
+    // type
+    any
+    ```
     #### getter: adapterType
     ```js
@@ Expand Down @@