@jbrowse/plugin-arc 2.8.0 → 2.10.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (9) hide show
  1. package/dist/LinearArcDisplay/model.d.ts +37 -29
  2. package/dist/LinearArcDisplay/model.js +2 -1
  3. package/dist/LinearPairedArcDisplay/model.d.ts +14 -6
  4. package/dist/LinearPairedArcDisplay/model.js +7 -1
  5. package/esm/LinearArcDisplay/model.d.ts +37 -29
  6. package/esm/LinearArcDisplay/model.js +2 -1
  7. package/esm/LinearPairedArcDisplay/model.d.ts +14 -6
  8. package/esm/LinearPairedArcDisplay/model.js +7 -1
  9. package/package.json +2 -2
package/dist/LinearArcDisplay/model.d.ts CHANGED
@@ -2,12 +2,15 @@
2
2
  import { AnyConfigurationSchemaType } from '@jbrowse/core/configuration';
3
3
  /**
4
4
  * #stateModel LinearArcDisplay
5
- * extends BaseLinearDisplay
5
+ * extends
6
+ * - [BaseLinearDisplay](../baselineardisplay)
6
7
  */
7
8
  export declare function stateModelFactory(configSchema: AnyConfigurationSchemaType): import("mobx-state-tree").IModelType<{
8
9
  id: import("mobx-state-tree").IOptionalIType<import("mobx-state-tree").ISimpleType<string>, [undefined]>;
9
10
  type: import("mobx-state-tree").ISimpleType<string>;
10
- rpcDriverName: import("mobx-state-tree").IMaybe<import("mobx-state-tree").ISimpleType<string>>;
11
+ rpcDriverName: import("mobx-state-tree").IMaybe<import("mobx-state-tree").ISimpleType<string>>; /**
12
+ * #property
13
+ */
11
14
  } & {
12
15
  heightPreConfig: import("mobx-state-tree").IMaybe<import("mobx-state-tree").ISimpleType<number>>;
13
16
  } & {
@@ -63,25 +66,29 @@ export declare function stateModelFactory(configSchema: AnyConfigurationSchemaTy
63
66
  configuration: import("@jbrowse/core/configuration/configurationSchema").ConfigurationSchemaType<{
64
67
  maxFeatureScreenDensity: {
65
68
  type: string;
66
- description: string; /**
69
+ description: string;
70
+ defaultValue: number; /**
67
71
  * #property
68
72
  */
69
- defaultValue: number;
70
- };
73
+ }; /**
74
+ * #property
75
+ */
71
76
  fetchSizeLimit: {
72
77
  type: string;
73
78
  defaultValue: number;
74
- description: string;
79
+ description: string; /**
80
+ * #getter
81
+ */
75
82
  };
76
83
  height: {
77
84
  type: string;
78
- defaultValue: number;
85
+ defaultValue: number; /**
86
+ * #getter
87
+ */
79
88
  description: string;
80
89
  };
81
90
  mouseover: {
82
- type: string; /**
83
- * #getter
84
- */
91
+ type: string;
85
92
  description: string;
86
93
  defaultValue: string;
87
94
  contextVariable: string[];
@@ -106,9 +113,6 @@ export declare function stateModelFactory(configSchema: AnyConfigurationSchemaTy
106
113
  message: string | undefined;
107
114
  } & {
108
115
  readonly RenderingComponent: import("react").FC<{
109
- /**
110
- * #property
111
- */
112
116
  model: {
113
117
  id: string;
114
118
  type: string;
@@ -164,9 +168,7 @@ export declare function stateModelFactory(configSchema: AnyConfigurationSchemaTy
164
168
  } & {
165
169
  scrollTop: number;
166
170
  } & {
167
- readonly height: number; /**
168
- * #property
169
- */
171
+ readonly height: number;
170
172
  } & {
171
173
  setScrollTop(scrollTop: number): void;
172
174
  setHeight(displayHeight: number): number;
@@ -180,9 +182,7 @@ export declare function stateModelFactory(configSchema: AnyConfigurationSchemaTy
180
182
  readonly currentFeatureScreenDensity: number;
181
183
  readonly maxFeatureScreenDensity: any;
182
184
  readonly featureDensityStatsReady: boolean;
183
- readonly maxAllowableBytes: number; /**
184
- * #method
185
- */
185
+ readonly maxAllowableBytes: number;
186
186
  } & {
187
187
  afterAttach(): void;
188
188
  } & {
@@ -200,7 +200,9 @@ export declare function stateModelFactory(configSchema: AnyConfigurationSchemaTy
200
200
  regionCannotBeRendered(_region: import("@jbrowse/core/util").Region): import("react").JSX.Element | null;
201
201
  } & {
202
202
  featureIdUnderMouse: string | undefined;
203
- contextMenuFeature: import("@jbrowse/core/util").Feature | undefined;
203
+ contextMenuFeature: import("@jbrowse/core/util").Feature | undefined; /**
204
+ * #method
205
+ */
204
206
  } & {
205
207
  readonly blockType: "dynamicBlocks" | "staticBlocks";
206
208
  readonly blockDefinitions: import("@jbrowse/core/util/blockTypes").BlockSet;
@@ -286,7 +288,9 @@ export declare function stateModelFactory(configSchema: AnyConfigurationSchemaTy
286
288
  } & Partial<import("mobx-state-tree/dist/internal").ExtractCFromProps<{
287
289
  id: import("mobx-state-tree").IOptionalIType<import("mobx-state-tree").ISimpleType<string>, [undefined]>;
288
290
  type: import("mobx-state-tree").ISimpleType<string>;
289
- rpcDriverName: import("mobx-state-tree").IMaybe<import("mobx-state-tree").ISimpleType<string>>;
291
+ rpcDriverName: import("mobx-state-tree").IMaybe<import("mobx-state-tree").ISimpleType<string>>; /**
292
+ * #property
293
+ */
290
294
  } & {
291
295
  heightPreConfig: import("mobx-state-tree").IMaybe<import("mobx-state-tree").ISimpleType<number>>;
292
296
  } & {
@@ -342,25 +346,29 @@ export declare function stateModelFactory(configSchema: AnyConfigurationSchemaTy
342
346
  configuration: import("@jbrowse/core/configuration/configurationSchema").ConfigurationSchemaType<{
343
347
  maxFeatureScreenDensity: {
344
348
  type: string;
345
- description: string; /**
349
+ description: string;
350
+ defaultValue: number; /**
346
351
  * #property
347
352
  */
348
- defaultValue: number;
349
- };
353
+ }; /**
354
+ * #property
355
+ */
350
356
  fetchSizeLimit: {
351
357
  type: string;
352
358
  defaultValue: number;
353
- description: string;
359
+ description: string; /**
360
+ * #getter
361
+ */
354
362
  };
355
363
  height: {
356
364
  type: string;
357
- defaultValue: number;
365
+ defaultValue: number; /**
366
+ * #getter
367
+ */
358
368
  description: string;
359
369
  };
360
370
  mouseover: {
361
- type: string; /**
362
- * #getter
363
- */
371
+ type: string;
364
372
  description: string;
365
373
  defaultValue: string;
366
374
  contextVariable: string[];
package/dist/LinearArcDisplay/model.js CHANGED
@@ -7,7 +7,8 @@ const plugin_linear_genome_view_1 = require("@jbrowse/plugin-linear-genome-view"
7
7
  const util_1 = require("@jbrowse/core/util");
8
8
  /**
9
9
  * #stateModel LinearArcDisplay
10
- * extends BaseLinearDisplay
10
+ * extends
11
+ * - [BaseLinearDisplay](../baselineardisplay)
11
12
  */
12
13
  function stateModelFactory(configSchema) {
13
14
  return mobx_state_tree_1.types
package/dist/LinearPairedArcDisplay/model.d.ts CHANGED
@@ -4,7 +4,13 @@ import { Instance } from 'mobx-state-tree';
4
4
  import { Feature } from '@jbrowse/core/util';
5
5
  /**
6
6
  * #stateModel LinearPairedArcDisplay
7
- * extends BaseDisplay, TrackHeightMixin, FeatureDensityMixin
7
+ * this is a non-block-based track type, and can connect arcs across multiple
8
+ * displayedRegions
9
+ *
10
+ * extends
11
+ * - [BaseDisplay](../basedisplay)
12
+ * - [TrackHeightMixin](../trackheightmixin)
13
+ * - [FeatureDensityMixin](../featuredensitymixin)
8
14
  */
9
15
  export declare function stateModelFactory(configSchema: AnyConfigurationSchemaType): import("mobx-state-tree").IModelType<{
10
16
  id: import("mobx-state-tree").IOptionalIType<import("mobx-state-tree").ISimpleType<string>, [undefined]>;
@@ -14,7 +20,9 @@ export declare function stateModelFactory(configSchema: AnyConfigurationSchemaTy
14
20
  heightPreConfig: import("mobx-state-tree").IMaybe<import("mobx-state-tree").ISimpleType<number>>;
15
21
  } & {
16
22
  userBpPerPxLimit: import("mobx-state-tree").IMaybe<import("mobx-state-tree").ISimpleType<number>>;
17
- userByteSizeLimit: import("mobx-state-tree").IMaybe<import("mobx-state-tree").ISimpleType<number>>;
23
+ userByteSizeLimit: import("mobx-state-tree").IMaybe<import("mobx-state-tree").ISimpleType<number>>; /**
24
+ * #property
25
+ */
18
26
  } & {
19
27
  /**
20
28
  * #property
@@ -92,13 +100,13 @@ export declare function stateModelFactory(configSchema: AnyConfigurationSchemaTy
92
100
  readonly height: number;
93
101
  } & {
94
102
  setScrollTop(scrollTop: number): void;
95
- setHeight(displayHeight: number): number; /**
96
- * #property
97
- */
103
+ setHeight(displayHeight: number): number;
98
104
  resizeHeight(distance: number): number;
99
105
  } & {
100
106
  featureDensityStatsP: Promise<import("@jbrowse/core/data_adapters/BaseAdapter").FeatureDensityStats> | undefined;
101
- featureDensityStats: import("@jbrowse/core/data_adapters/BaseAdapter").FeatureDensityStats | undefined;
107
+ featureDensityStats: import("@jbrowse/core/data_adapters/BaseAdapter").FeatureDensityStats | undefined; /**
108
+ * #property
109
+ */
102
110
  currStatsBpPerPx: number;
103
111
  } & {
104
112
  readonly currentBytesRequested: number;
package/dist/LinearPairedArcDisplay/model.js CHANGED
@@ -31,7 +31,13 @@ const pluggableElementTypes_1 = require("@jbrowse/core/pluggableElementTypes");
31
31
  const plugin_linear_genome_view_1 = require("@jbrowse/plugin-linear-genome-view");
32
32
  /**
33
33
  * #stateModel LinearPairedArcDisplay
34
- * extends BaseDisplay, TrackHeightMixin, FeatureDensityMixin
34
+ * this is a non-block-based track type, and can connect arcs across multiple
35
+ * displayedRegions
36
+ *
37
+ * extends
38
+ * - [BaseDisplay](../basedisplay)
39
+ * - [TrackHeightMixin](../trackheightmixin)
40
+ * - [FeatureDensityMixin](../featuredensitymixin)
35
41
  */
36
42
  function stateModelFactory(configSchema) {
37
43
  return mobx_state_tree_1.types
package/esm/LinearArcDisplay/model.d.ts CHANGED
@@ -2,12 +2,15 @@
2
2
  import { AnyConfigurationSchemaType } from '@jbrowse/core/configuration';
3
3
  /**
4
4
  * #stateModel LinearArcDisplay
5
- * extends BaseLinearDisplay
5
+ * extends
6
+ * - [BaseLinearDisplay](../baselineardisplay)
6
7
  */
7
8
  export declare function stateModelFactory(configSchema: AnyConfigurationSchemaType): import("mobx-state-tree").IModelType<{
8
9
  id: import("mobx-state-tree").IOptionalIType<import("mobx-state-tree").ISimpleType<string>, [undefined]>;
9
10
  type: import("mobx-state-tree").ISimpleType<string>;
10
- rpcDriverName: import("mobx-state-tree").IMaybe<import("mobx-state-tree").ISimpleType<string>>;
11
+ rpcDriverName: import("mobx-state-tree").IMaybe<import("mobx-state-tree").ISimpleType<string>>; /**
12
+ * #property
13
+ */
11
14
  } & {
12
15
  heightPreConfig: import("mobx-state-tree").IMaybe<import("mobx-state-tree").ISimpleType<number>>;
13
16
  } & {
@@ -63,25 +66,29 @@ export declare function stateModelFactory(configSchema: AnyConfigurationSchemaTy
63
66
  configuration: import("@jbrowse/core/configuration/configurationSchema").ConfigurationSchemaType<{
64
67
  maxFeatureScreenDensity: {
65
68
  type: string;
66
- description: string; /**
69
+ description: string;
70
+ defaultValue: number; /**
67
71
  * #property
68
72
  */
69
- defaultValue: number;
70
- };
73
+ }; /**
74
+ * #property
75
+ */
71
76
  fetchSizeLimit: {
72
77
  type: string;
73
78
  defaultValue: number;
74
- description: string;
79
+ description: string; /**
80
+ * #getter
81
+ */
75
82
  };
76
83
  height: {
77
84
  type: string;
78
- defaultValue: number;
85
+ defaultValue: number; /**
86
+ * #getter
87
+ */
79
88
  description: string;
80
89
  };
81
90
  mouseover: {
82
- type: string; /**
83
- * #getter
84
- */
91
+ type: string;
85
92
  description: string;
86
93
  defaultValue: string;
87
94
  contextVariable: string[];
@@ -106,9 +113,6 @@ export declare function stateModelFactory(configSchema: AnyConfigurationSchemaTy
106
113
  message: string | undefined;
107
114
  } & {
108
115
  readonly RenderingComponent: import("react").FC<{
109
- /**
110
- * #property
111
- */
112
116
  model: {
113
117
  id: string;
114
118
  type: string;
@@ -164,9 +168,7 @@ export declare function stateModelFactory(configSchema: AnyConfigurationSchemaTy
164
168
  } & {
165
169
  scrollTop: number;
166
170
  } & {
167
- readonly height: number; /**
168
- * #property
169
- */
171
+ readonly height: number;
170
172
  } & {
171
173
  setScrollTop(scrollTop: number): void;
172
174
  setHeight(displayHeight: number): number;
@@ -180,9 +182,7 @@ export declare function stateModelFactory(configSchema: AnyConfigurationSchemaTy
180
182
  readonly currentFeatureScreenDensity: number;
181
183
  readonly maxFeatureScreenDensity: any;
182
184
  readonly featureDensityStatsReady: boolean;
183
- readonly maxAllowableBytes: number; /**
184
- * #method
185
- */
185
+ readonly maxAllowableBytes: number;
186
186
  } & {
187
187
  afterAttach(): void;
188
188
  } & {
@@ -200,7 +200,9 @@ export declare function stateModelFactory(configSchema: AnyConfigurationSchemaTy
200
200
  regionCannotBeRendered(_region: import("@jbrowse/core/util").Region): import("react").JSX.Element | null;
201
201
  } & {
202
202
  featureIdUnderMouse: string | undefined;
203
- contextMenuFeature: import("@jbrowse/core/util").Feature | undefined;
203
+ contextMenuFeature: import("@jbrowse/core/util").Feature | undefined; /**
204
+ * #method
205
+ */
204
206
  } & {
205
207
  readonly blockType: "dynamicBlocks" | "staticBlocks";
206
208
  readonly blockDefinitions: import("@jbrowse/core/util/blockTypes").BlockSet;
@@ -286,7 +288,9 @@ export declare function stateModelFactory(configSchema: AnyConfigurationSchemaTy
286
288
  } & Partial<import("mobx-state-tree/dist/internal").ExtractCFromProps<{
287
289
  id: import("mobx-state-tree").IOptionalIType<import("mobx-state-tree").ISimpleType<string>, [undefined]>;
288
290
  type: import("mobx-state-tree").ISimpleType<string>;
289
- rpcDriverName: import("mobx-state-tree").IMaybe<import("mobx-state-tree").ISimpleType<string>>;
291
+ rpcDriverName: import("mobx-state-tree").IMaybe<import("mobx-state-tree").ISimpleType<string>>; /**
292
+ * #property
293
+ */
290
294
  } & {
291
295
  heightPreConfig: import("mobx-state-tree").IMaybe<import("mobx-state-tree").ISimpleType<number>>;
292
296
  } & {
@@ -342,25 +346,29 @@ export declare function stateModelFactory(configSchema: AnyConfigurationSchemaTy
342
346
  configuration: import("@jbrowse/core/configuration/configurationSchema").ConfigurationSchemaType<{
343
347
  maxFeatureScreenDensity: {
344
348
  type: string;
345
- description: string; /**
349
+ description: string;
350
+ defaultValue: number; /**
346
351
  * #property
347
352
  */
348
- defaultValue: number;
349
- };
353
+ }; /**
354
+ * #property
355
+ */
350
356
  fetchSizeLimit: {
351
357
  type: string;
352
358
  defaultValue: number;
353
- description: string;
359
+ description: string; /**
360
+ * #getter
361
+ */
354
362
  };
355
363
  height: {
356
364
  type: string;
357
- defaultValue: number;
365
+ defaultValue: number; /**
366
+ * #getter
367
+ */
358
368
  description: string;
359
369
  };
360
370
  mouseover: {
361
- type: string; /**
362
- * #getter
363
- */
371
+ type: string;
364
372
  description: string;
365
373
  defaultValue: string;
366
374
  contextVariable: string[];
package/esm/LinearArcDisplay/model.js CHANGED
@@ -4,7 +4,8 @@ import { BaseLinearDisplay } from '@jbrowse/plugin-linear-genome-view';
4
4
  import { getEnv } from '@jbrowse/core/util';
5
5
  /**
6
6
  * #stateModel LinearArcDisplay
7
- * extends BaseLinearDisplay
7
+ * extends
8
+ * - [BaseLinearDisplay](../baselineardisplay)
8
9
  */
9
10
  export function stateModelFactory(configSchema) {
10
11
  return types
package/esm/LinearPairedArcDisplay/model.d.ts CHANGED
@@ -4,7 +4,13 @@ import { Instance } from 'mobx-state-tree';
4
4
  import { Feature } from '@jbrowse/core/util';
5
5
  /**
6
6
  * #stateModel LinearPairedArcDisplay
7
- * extends BaseDisplay, TrackHeightMixin, FeatureDensityMixin
7
+ * this is a non-block-based track type, and can connect arcs across multiple
8
+ * displayedRegions
9
+ *
10
+ * extends
11
+ * - [BaseDisplay](../basedisplay)
12
+ * - [TrackHeightMixin](../trackheightmixin)
13
+ * - [FeatureDensityMixin](../featuredensitymixin)
8
14
  */
9
15
  export declare function stateModelFactory(configSchema: AnyConfigurationSchemaType): import("mobx-state-tree").IModelType<{
10
16
  id: import("mobx-state-tree").IOptionalIType<import("mobx-state-tree").ISimpleType<string>, [undefined]>;
@@ -14,7 +20,9 @@ export declare function stateModelFactory(configSchema: AnyConfigurationSchemaTy
14
20
  heightPreConfig: import("mobx-state-tree").IMaybe<import("mobx-state-tree").ISimpleType<number>>;
15
21
  } & {
16
22
  userBpPerPxLimit: import("mobx-state-tree").IMaybe<import("mobx-state-tree").ISimpleType<number>>;
17
- userByteSizeLimit: import("mobx-state-tree").IMaybe<import("mobx-state-tree").ISimpleType<number>>;
23
+ userByteSizeLimit: import("mobx-state-tree").IMaybe<import("mobx-state-tree").ISimpleType<number>>; /**
24
+ * #property
25
+ */
18
26
  } & {
19
27
  /**
20
28
  * #property
@@ -92,13 +100,13 @@ export declare function stateModelFactory(configSchema: AnyConfigurationSchemaTy
92
100
  readonly height: number;
93
101
  } & {
94
102
  setScrollTop(scrollTop: number): void;
95
- setHeight(displayHeight: number): number; /**
96
- * #property
97
- */
103
+ setHeight(displayHeight: number): number;
98
104
  resizeHeight(distance: number): number;
99
105
  } & {
100
106
  featureDensityStatsP: Promise<import("@jbrowse/core/data_adapters/BaseAdapter").FeatureDensityStats> | undefined;
101
- featureDensityStats: import("@jbrowse/core/data_adapters/BaseAdapter").FeatureDensityStats | undefined;
107
+ featureDensityStats: import("@jbrowse/core/data_adapters/BaseAdapter").FeatureDensityStats | undefined; /**
108
+ * #property
109
+ */
102
110
  currStatsBpPerPx: number;
103
111
  } & {
104
112
  readonly currentBytesRequested: number;
package/esm/LinearPairedArcDisplay/model.js CHANGED
@@ -5,7 +5,13 @@ import { BaseDisplay } from '@jbrowse/core/pluggableElementTypes';
5
5
  import { FeatureDensityMixin, TrackHeightMixin, } from '@jbrowse/plugin-linear-genome-view';
6
6
  /**
7
7
  * #stateModel LinearPairedArcDisplay
8
- * extends BaseDisplay, TrackHeightMixin, FeatureDensityMixin
8
+ * this is a non-block-based track type, and can connect arcs across multiple
9
+ * displayedRegions
10
+ *
11
+ * extends
12
+ * - [BaseDisplay](../basedisplay)
13
+ * - [TrackHeightMixin](../trackheightmixin)
14
+ * - [FeatureDensityMixin](../featuredensitymixin)
9
15
  */
10
16
  export function stateModelFactory(configSchema) {
11
17
  return types
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@jbrowse/plugin-arc",
3
- "version": "2.8.0",
3
+ "version": "2.10.0",
4
4
  "description": "JBrowse 2 arc adapters, tracks, etc.",
5
5
  "keywords": [
6
6
  "jbrowse",
@@ -56,5 +56,5 @@
56
56
  "publishConfig": {
57
57
  "access": "public"
58
58
  },
59
- "gitHead": "ee8c2bdc8bd4f1a70b1eefda984f04a2830d9ca0"
59
+ "gitHead": "223d8bfb68fd1bacaf22852639ad5920f1b7f43b"
60
60
  }