From 2e5ef842fd11d78c1738c233d89519ea949e1543 Mon Sep 17 00:00:00 2001 From: Colin Date: Thu, 13 Feb 2025 16:45:43 -0500 Subject: [PATCH] [update docs] Autogen docs --- website/docs/config/GtfAdapter.md | 9 ++++++ website/docs/config/LinearSyntenyDisplay.md | 5 ++- website/docs/config/WiggleRenderer.md | 3 ++ website/docs/models/BaseTrackModel.md | 7 +++++ website/docs/models/JobsListModel.md | 6 ++-- .../docs/models/LinearSNPCoverageDisplay.md | 2 +- website/docs/models/LinearWiggleDisplay.md | 31 ++++++++++++++++--- .../docs/models/MultiLinearWiggleDisplay.md | 2 +- 8 files changed, 55 insertions(+), 10 deletions(-) diff --git a/website/docs/config/GtfAdapter.md b/website/docs/config/GtfAdapter.md index 5ce678e929..6dc18b459c 100644 --- 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 index 4fb4c074a2..9194a3b351 100644 --- 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 index ebf56a35e0..267a8f9ed8 100644 --- 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 index 9d24b3a1f3..6cdf49485f 100644 --- 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 index fc84ff1f50..393e984e7b 100644 --- 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; statusMessage: IMaybe>; progressPct: ISimpleType; }, { ...; } & { ...; }, _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; statusMessage: IMaybe>; progressPct: ISimpleType; }, { ...; } & { ...; }, _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; statusMessage: IMaybe>; progressPct: ISimpleType; }, { ...; } & { ...; }, _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 index 5d6bac065b..08ffa77fe6 100644 --- 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 index 247515c09c..3698aab6ec 100644 --- 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> +// 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 | ScaleQuantize; } +boolean ``` -#### getter: needsScalebar +#### getter: inverted ```js // type -boolean +any +``` + +#### getter: ticks + +```js +// type +{ range: number[]; values: number[]; format: (d: NumberValue) => string; position: ScaleLinear | ScaleQuantize; } ``` #### 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 index e9fa04668a..139b67d4ac 100644 --- a/website/docs/models/MultiLinearWiggleDisplay.md +++ b/website/docs/models/MultiLinearWiggleDisplay.md @@ -67,7 +67,7 @@ React.ComponentType string ``` -#### getter: needsScalebar +#### getter: graphType ```js // type