@vitessce/constants-internal 3.4.9 → 3.4.11

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.
package/dist/index.js CHANGED
@@ -37,6 +37,7 @@ const FileType = {
37
37
  // Joint file types
38
38
  ANNDATA_ZARR: "anndata.zarr",
39
39
  ANNDATA_ZARR_ZIP: "anndata.zarr.zip",
40
+ ANNDATA_H5AD: "anndata.h5ad",
40
41
  SPATIALDATA_ZARR: "spatialdata.zarr",
41
42
  // Atomic file types
42
43
  OBS_EMBEDDING_CSV: "obsEmbedding.csv",
@@ -77,6 +78,18 @@ const FileType = {
77
78
  OBS_LABELS_ANNDATA_ZARR_ZIP: "obsLabels.anndata.zarr.zip",
78
79
  FEATURE_LABELS_ANNDATA_ZARR_ZIP: "featureLabels.anndata.zarr.zip",
79
80
  SAMPLE_EDGES_ANNDATA_ZARR_ZIP: "sampleEdges.anndata.zarr.zip",
81
+ // AnnData - h5ad via reference spec
82
+ OBS_FEATURE_MATRIX_ANNDATA_H5AD: "obsFeatureMatrix.anndata.h5ad",
83
+ OBS_FEATURE_COLUMNS_ANNDATA_H5AD: "obsFeatureColumns.anndata.h5ad",
84
+ OBS_SETS_ANNDATA_H5AD: "obsSets.anndata.h5ad",
85
+ OBS_EMBEDDING_ANNDATA_H5AD: "obsEmbedding.anndata.h5ad",
86
+ OBS_SPOTS_ANNDATA_H5AD: "obsSpots.anndata.h5ad",
87
+ OBS_POINTS_ANNDATA_H5AD: "obsPoints.anndata.h5ad",
88
+ OBS_LOCATIONS_ANNDATA_H5AD: "obsLocations.anndata.h5ad",
89
+ OBS_SEGMENTATIONS_ANNDATA_H5AD: "obsSegmentations.anndata.h5ad",
90
+ OBS_LABELS_ANNDATA_H5AD: "obsLabels.anndata.h5ad",
91
+ FEATURE_LABELS_ANNDATA_H5AD: "featureLabels.anndata.h5ad",
92
+ SAMPLE_EDGES_ANNDATA_H5AD: "sampleEdges.anndata.h5ad",
80
93
  // SpatialData
81
94
  IMAGE_SPATIALDATA_ZARR: "image.spatialdata.zarr",
82
95
  LABELS_SPATIALDATA_ZARR: "labels.spatialdata.zarr",
@@ -266,6 +279,27 @@ const STATUS = {
266
279
  SUCCESS: "success",
267
280
  ERROR: "error"
268
281
  };
282
+ const DescriptionType = {
283
+ PLAIN: "plain",
284
+ MARKDOWN: "markdown"
285
+ };
286
+ const ViewHelpMapping = {
287
+ SCATTERPLOT: "The scatterplot displays two-dimensional (pre-computed) dimensionality reduction results (such as from t-SNE or UMAP). Each point on the scatterplot represents an observation (e.g., cell).",
288
+ HEATMAP: "The heatmap displays an observation-by-feature (e.g., cell-by-gene) matrix, typically with transformed (e.g., normalized or standardized) values.",
289
+ SPATIAL: "The spatial view displays (potentially layered) spatially-resolved data including RGB or multiplexed images, segmentations of observations (bitmask- or polygon-based), and/or points (e.g., representing FISH transcripts).",
290
+ DESCRIPTION: "The description view displays additional information about a dataset. When images are included in a dataset, the description view also includes image metadata (if contained in the image files).",
291
+ STATUS: "The status view displays debugging messages, including app-wide error messages when datasets fail to load or when schemas fail to validate. Details about the entity under the mouse cursor (cell, gene, and/or molecule) are displayed during hover interactions.",
292
+ LAYER_CONTROLLER: "The spatial layer controller provides an interface for manipulating the visualization layers displayed in the spatial view.",
293
+ GENOMIC_PROFILES: "The genomic profiles view displays genome browser tracks (using the genomic-profiles data type) containing bar plots, where the genome is along the x-axis and the value at each genome position is encoded with a bar along the y-axis.",
294
+ GATING: "The gating scatterplot displays expression data for two genes (along the X and Y axes). Users can select two genes, and the scatterplot is dynamically generated using observation-by-feature matrix data. Gating can then be performed by using the lasso or box select tools.",
295
+ FEATURE_LIST: "The feature list controller displays an interactive list of features (e.g., genes).",
296
+ OBS_SETS: "The observation sets controller displays an interactive list of (potentially hierarchical) observation sets (e.g., cell clusters or cell type annotations).",
297
+ OBS_SET_SIZES: "The observation set sizes view displays a bar plot with the currently-selected observation sets (e.g., cell types) on the x-axis and bars representing their size (e.g., number of cells) on the y-axis.",
298
+ OBS_SET_FEATURE_VALUE_DISTRIBUTION: "The observation set feature value distribution view displays a violin plot with values (e.g., expression values) per set (e.g., cell type) for the selected feature (e.g., gene).",
299
+ FEATURE_VALUE_HISTOGRAM: "The feature value histogram displays the distribution of values (e.g., expression) for the selected feature (e.g., gene).",
300
+ DOT_PLOT: "The dot plot displays summary information about expression of the selected features (e.g., genes) for each selected observation set (e.g., cell type).",
301
+ FEATURE_BAR_PLOT: "The feature bar plot displays one bar per observation (e.g., cell) along the x-axis, where the value of a selected feature (e.g., gene) is encoded along the y-axis."
302
+ };
269
303
  const FILE_TYPE_DATA_TYPE_MAPPING = {
270
304
  // For new file types
271
305
  [FileType.OBS_EMBEDDING_CSV]: DataType.OBS_EMBEDDING,
@@ -376,37 +410,48 @@ const DATA_TYPE_COORDINATION_VALUE_USAGE = {
376
410
  };
377
411
  const ALT_ZARR_STORE_TYPES = {
378
412
  [FileType.OBS_FEATURE_MATRIX_ANNDATA_ZARR]: {
379
- zip: FileType.OBS_FEATURE_MATRIX_ANNDATA_ZARR_ZIP
413
+ zip: FileType.OBS_FEATURE_MATRIX_ANNDATA_ZARR_ZIP,
414
+ h5ad: FileType.OBS_FEATURE_MATRIX_ANNDATA_H5AD
380
415
  },
381
416
  [FileType.OBS_FEATURE_COLUMNS_ANNDATA_ZARR]: {
382
- zip: FileType.OBS_FEATURE_COLUMNS_ANNDATA_ZARR_ZIP
417
+ zip: FileType.OBS_FEATURE_COLUMNS_ANNDATA_ZARR_ZIP,
418
+ h5ad: FileType.OBS_FEATURE_COLUMNS_ANNDATA_H5AD
383
419
  },
384
420
  [FileType.OBS_SETS_ANNDATA_ZARR]: {
385
- zip: FileType.OBS_SETS_ANNDATA_ZARR_ZIP
421
+ zip: FileType.OBS_SETS_ANNDATA_ZARR_ZIP,
422
+ h5ad: FileType.OBS_SETS_ANNDATA_H5AD
386
423
  },
387
424
  [FileType.OBS_EMBEDDING_ANNDATA_ZARR]: {
388
- zip: FileType.OBS_EMBEDDING_ANNDATA_ZARR_ZIP
425
+ zip: FileType.OBS_EMBEDDING_ANNDATA_ZARR_ZIP,
426
+ h5ad: FileType.OBS_EMBEDDING_ANNDATA_H5AD
389
427
  },
390
428
  [FileType.OBS_SPOTS_ANNDATA_ZARR]: {
391
- zip: FileType.OBS_SPOTS_ANNDATA_ZARR_ZIP
429
+ zip: FileType.OBS_SPOTS_ANNDATA_ZARR_ZIP,
430
+ h5ad: FileType.OBS_SPOTS_ANNDATA_H5AD
392
431
  },
393
432
  [FileType.OBS_POINTS_ANNDATA_ZARR]: {
394
- zip: FileType.OBS_POINTS_ANNDATA_ZARR_ZIP
433
+ zip: FileType.OBS_POINTS_ANNDATA_ZARR_ZIP,
434
+ h5ad: FileType.OBS_POINTS_ANNDATA_H5AD
395
435
  },
396
436
  [FileType.OBS_LOCATIONS_ANNDATA_ZARR]: {
397
- zip: FileType.OBS_LOCATIONS_ANNDATA_ZARR_ZIP
437
+ zip: FileType.OBS_LOCATIONS_ANNDATA_ZARR_ZIP,
438
+ h5ad: FileType.OBS_LOCATIONS_ANNDATA_H5AD
398
439
  },
399
440
  [FileType.OBS_SEGMENTATIONS_ANNDATA_ZARR]: {
400
- zip: FileType.OBS_SEGMENTATIONS_ANNDATA_ZARR_ZIP
441
+ zip: FileType.OBS_SEGMENTATIONS_ANNDATA_ZARR_ZIP,
442
+ h5ad: FileType.OBS_SEGMENTATIONS_ANNDATA_H5AD
401
443
  },
402
444
  [FileType.OBS_LABELS_ANNDATA_ZARR]: {
403
- zip: FileType.OBS_LABELS_ANNDATA_ZARR_ZIP
445
+ zip: FileType.OBS_LABELS_ANNDATA_ZARR_ZIP,
446
+ h5ad: FileType.OBS_LABELS_ANNDATA_H5AD
404
447
  },
405
448
  [FileType.FEATURE_LABELS_ANNDATA_ZARR]: {
406
- zip: FileType.FEATURE_LABELS_ANNDATA_ZARR_ZIP
449
+ zip: FileType.FEATURE_LABELS_ANNDATA_ZARR_ZIP,
450
+ h5ad: FileType.FEATURE_LABELS_ANNDATA_H5AD
407
451
  },
408
452
  [FileType.SAMPLE_EDGES_ANNDATA_ZARR]: {
409
- zip: FileType.SAMPLE_EDGES_ANNDATA_ZARR_ZIP
453
+ zip: FileType.SAMPLE_EDGES_ANNDATA_ZARR_ZIP,
454
+ h5ad: FileType.SAMPLE_EDGES_ANNDATA_H5AD
410
455
  }
411
456
  };
412
457
  const AUTO_INDEPENDENT_COORDINATION_TYPES = [
@@ -842,10 +887,10 @@ const COMPONENT_COORDINATION_TYPES = {
842
887
  ]
843
888
  };
844
889
  const note = "This file is autogenerated by .changeset/post-changelog.mjs.";
845
- const version = "3.4.9";
846
- const date = "2024-07-26";
890
+ const version = "3.4.11";
891
+ const date = "2024-09-27";
847
892
  const branch = "changeset-release/main";
848
- const hash = "9582ddcf";
893
+ const hash = "efd7d698";
849
894
  const version$1 = {
850
895
  note,
851
896
  version,
@@ -860,9 +905,11 @@ export {
860
905
  CoordinationType,
861
906
  DATA_TYPE_COORDINATION_VALUE_USAGE,
862
907
  DataType,
908
+ DescriptionType,
863
909
  FILE_TYPE_DATA_TYPE_MAPPING,
864
910
  FileType,
865
911
  version$1 as META_VERSION,
866
912
  STATUS,
913
+ ViewHelpMapping,
867
914
  ViewType
868
915
  };
@@ -17,6 +17,7 @@ export declare const DATA_TYPE_COORDINATION_VALUE_USAGE: {
17
17
  export declare const ALT_ZARR_STORE_TYPES: {
18
18
  [x: string]: {
19
19
  zip: string;
20
+ h5ad: string;
20
21
  };
21
22
  };
22
23
  //# sourceMappingURL=constant-relationships.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"constant-relationships.d.ts","sourceRoot":"","sources":["../src/constant-relationships.ts"],"names":[],"mappings":"AAEA;;;;GAIG;AACH,eAAO,MAAM,2BAA2B;;CA+DvC,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,kCAAkC;;CA6C9C,CAAC;AAKF,eAAO,MAAM,oBAAoB;;;;CAkChC,CAAC"}
1
+ {"version":3,"file":"constant-relationships.d.ts","sourceRoot":"","sources":["../src/constant-relationships.ts"],"names":[],"mappings":"AAEA;;;;GAIG;AACH,eAAO,MAAM,2BAA2B;;CA+DvC,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,kCAAkC;;CA6C9C,CAAC;AAKF,eAAO,MAAM,oBAAoB;;;;;CA6ChC,CAAC"}
@@ -123,35 +123,46 @@ export const DATA_TYPE_COORDINATION_VALUE_USAGE = {
123
123
  export const ALT_ZARR_STORE_TYPES = {
124
124
  [FileType.OBS_FEATURE_MATRIX_ANNDATA_ZARR]: {
125
125
  zip: FileType.OBS_FEATURE_MATRIX_ANNDATA_ZARR_ZIP,
126
+ h5ad: FileType.OBS_FEATURE_MATRIX_ANNDATA_H5AD,
126
127
  },
127
128
  [FileType.OBS_FEATURE_COLUMNS_ANNDATA_ZARR]: {
128
129
  zip: FileType.OBS_FEATURE_COLUMNS_ANNDATA_ZARR_ZIP,
130
+ h5ad: FileType.OBS_FEATURE_COLUMNS_ANNDATA_H5AD,
129
131
  },
130
132
  [FileType.OBS_SETS_ANNDATA_ZARR]: {
131
133
  zip: FileType.OBS_SETS_ANNDATA_ZARR_ZIP,
134
+ h5ad: FileType.OBS_SETS_ANNDATA_H5AD,
132
135
  },
133
136
  [FileType.OBS_EMBEDDING_ANNDATA_ZARR]: {
134
137
  zip: FileType.OBS_EMBEDDING_ANNDATA_ZARR_ZIP,
138
+ h5ad: FileType.OBS_EMBEDDING_ANNDATA_H5AD,
135
139
  },
136
140
  [FileType.OBS_SPOTS_ANNDATA_ZARR]: {
137
141
  zip: FileType.OBS_SPOTS_ANNDATA_ZARR_ZIP,
142
+ h5ad: FileType.OBS_SPOTS_ANNDATA_H5AD,
138
143
  },
139
144
  [FileType.OBS_POINTS_ANNDATA_ZARR]: {
140
145
  zip: FileType.OBS_POINTS_ANNDATA_ZARR_ZIP,
146
+ h5ad: FileType.OBS_POINTS_ANNDATA_H5AD,
141
147
  },
142
148
  [FileType.OBS_LOCATIONS_ANNDATA_ZARR]: {
143
149
  zip: FileType.OBS_LOCATIONS_ANNDATA_ZARR_ZIP,
150
+ h5ad: FileType.OBS_LOCATIONS_ANNDATA_H5AD,
144
151
  },
145
152
  [FileType.OBS_SEGMENTATIONS_ANNDATA_ZARR]: {
146
153
  zip: FileType.OBS_SEGMENTATIONS_ANNDATA_ZARR_ZIP,
154
+ h5ad: FileType.OBS_SEGMENTATIONS_ANNDATA_H5AD,
147
155
  },
148
156
  [FileType.OBS_LABELS_ANNDATA_ZARR]: {
149
157
  zip: FileType.OBS_LABELS_ANNDATA_ZARR_ZIP,
158
+ h5ad: FileType.OBS_LABELS_ANNDATA_H5AD,
150
159
  },
151
160
  [FileType.FEATURE_LABELS_ANNDATA_ZARR]: {
152
161
  zip: FileType.FEATURE_LABELS_ANNDATA_ZARR_ZIP,
162
+ h5ad: FileType.FEATURE_LABELS_ANNDATA_H5AD,
153
163
  },
154
164
  [FileType.SAMPLE_EDGES_ANNDATA_ZARR]: {
155
165
  zip: FileType.SAMPLE_EDGES_ANNDATA_ZARR_ZIP,
166
+ h5ad: FileType.SAMPLE_EDGES_ANNDATA_H5AD,
156
167
  },
157
168
  };
@@ -48,6 +48,7 @@ export declare const AsyncFunctionType: {
48
48
  export declare const FileType: {
49
49
  ANNDATA_ZARR: string;
50
50
  ANNDATA_ZARR_ZIP: string;
51
+ ANNDATA_H5AD: string;
51
52
  SPATIALDATA_ZARR: string;
52
53
  OBS_EMBEDDING_CSV: string;
53
54
  OBS_SPOTS_CSV: string;
@@ -84,6 +85,17 @@ export declare const FileType: {
84
85
  OBS_LABELS_ANNDATA_ZARR_ZIP: string;
85
86
  FEATURE_LABELS_ANNDATA_ZARR_ZIP: string;
86
87
  SAMPLE_EDGES_ANNDATA_ZARR_ZIP: string;
88
+ OBS_FEATURE_MATRIX_ANNDATA_H5AD: string;
89
+ OBS_FEATURE_COLUMNS_ANNDATA_H5AD: string;
90
+ OBS_SETS_ANNDATA_H5AD: string;
91
+ OBS_EMBEDDING_ANNDATA_H5AD: string;
92
+ OBS_SPOTS_ANNDATA_H5AD: string;
93
+ OBS_POINTS_ANNDATA_H5AD: string;
94
+ OBS_LOCATIONS_ANNDATA_H5AD: string;
95
+ OBS_SEGMENTATIONS_ANNDATA_H5AD: string;
96
+ OBS_LABELS_ANNDATA_H5AD: string;
97
+ FEATURE_LABELS_ANNDATA_H5AD: string;
98
+ SAMPLE_EDGES_ANNDATA_H5AD: string;
87
99
  IMAGE_SPATIALDATA_ZARR: string;
88
100
  LABELS_SPATIALDATA_ZARR: string;
89
101
  SHAPES_SPATIALDATA_ZARR: string;
@@ -249,4 +261,29 @@ export declare const STATUS: {
249
261
  SUCCESS: string;
250
262
  ERROR: string;
251
263
  };
264
+ export declare const DescriptionType: {
265
+ PLAIN: string;
266
+ MARKDOWN: string;
267
+ };
268
+ /**
269
+ * Constants representing the help text for
270
+ * each view.
271
+ */
272
+ export declare const ViewHelpMapping: {
273
+ SCATTERPLOT: string;
274
+ HEATMAP: string;
275
+ SPATIAL: string;
276
+ DESCRIPTION: string;
277
+ STATUS: string;
278
+ LAYER_CONTROLLER: string;
279
+ GENOMIC_PROFILES: string;
280
+ GATING: string;
281
+ FEATURE_LIST: string;
282
+ OBS_SETS: string;
283
+ OBS_SET_SIZES: string;
284
+ OBS_SET_FEATURE_VALUE_DISTRIBUTION: string;
285
+ FEATURE_VALUE_HISTOGRAM: string;
286
+ DOT_PLOT: string;
287
+ FEATURE_BAR_PLOT: string;
288
+ };
252
289
  //# sourceMappingURL=constants.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,eAAO,MAAM,QAAQ;;;;;;;;;;;;;;;;;;CAkBpB,CAAC;AAEF,eAAO,MAAM,QAAQ;;;;;;;;;;;;;;;CAepB,CAAC;AAEF,eAAO,MAAM,iBAAiB;;;;;;CAM7B,CAAC;AAGF,eAAO,MAAM,QAAQ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAwGpB,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,gBAAgB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAqH5B,CAAC;AAEF,eAAO,MAAM,MAAM;;;;CAIlB,CAAC"}
1
+ {"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,eAAO,MAAM,QAAQ;;;;;;;;;;;;;;;;;;CAkBpB,CAAC;AAEF,eAAO,MAAM,QAAQ;;;;;;;;;;;;;;;CAepB,CAAC;AAEF,eAAO,MAAM,iBAAiB;;;;;;CAM7B,CAAC;AAGF,eAAO,MAAM,QAAQ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAqHpB,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,gBAAgB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAqH5B,CAAC;AAEF,eAAO,MAAM,MAAM;;;;CAIlB,CAAC;AAEF,eAAO,MAAM,eAAe;;;CAG3B,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,eAAe;;;;;;;;;;;;;;;;CAgB3B,CAAC"}
@@ -49,6 +49,7 @@ export const FileType = {
49
49
  // Joint file types
50
50
  ANNDATA_ZARR: 'anndata.zarr',
51
51
  ANNDATA_ZARR_ZIP: 'anndata.zarr.zip',
52
+ ANNDATA_H5AD: 'anndata.h5ad',
52
53
  SPATIALDATA_ZARR: 'spatialdata.zarr',
53
54
  // Atomic file types
54
55
  OBS_EMBEDDING_CSV: 'obsEmbedding.csv',
@@ -89,6 +90,18 @@ export const FileType = {
89
90
  OBS_LABELS_ANNDATA_ZARR_ZIP: 'obsLabels.anndata.zarr.zip',
90
91
  FEATURE_LABELS_ANNDATA_ZARR_ZIP: 'featureLabels.anndata.zarr.zip',
91
92
  SAMPLE_EDGES_ANNDATA_ZARR_ZIP: 'sampleEdges.anndata.zarr.zip',
93
+ // AnnData - h5ad via reference spec
94
+ OBS_FEATURE_MATRIX_ANNDATA_H5AD: 'obsFeatureMatrix.anndata.h5ad',
95
+ OBS_FEATURE_COLUMNS_ANNDATA_H5AD: 'obsFeatureColumns.anndata.h5ad',
96
+ OBS_SETS_ANNDATA_H5AD: 'obsSets.anndata.h5ad',
97
+ OBS_EMBEDDING_ANNDATA_H5AD: 'obsEmbedding.anndata.h5ad',
98
+ OBS_SPOTS_ANNDATA_H5AD: 'obsSpots.anndata.h5ad',
99
+ OBS_POINTS_ANNDATA_H5AD: 'obsPoints.anndata.h5ad',
100
+ OBS_LOCATIONS_ANNDATA_H5AD: 'obsLocations.anndata.h5ad',
101
+ OBS_SEGMENTATIONS_ANNDATA_H5AD: 'obsSegmentations.anndata.h5ad',
102
+ OBS_LABELS_ANNDATA_H5AD: 'obsLabels.anndata.h5ad',
103
+ FEATURE_LABELS_ANNDATA_H5AD: 'featureLabels.anndata.h5ad',
104
+ SAMPLE_EDGES_ANNDATA_H5AD: 'sampleEdges.anndata.h5ad',
92
105
  // SpatialData
93
106
  IMAGE_SPATIALDATA_ZARR: 'image.spatialdata.zarr',
94
107
  LABELS_SPATIALDATA_ZARR: 'labels.spatialdata.zarr',
@@ -277,3 +290,28 @@ export const STATUS = {
277
290
  SUCCESS: 'success',
278
291
  ERROR: 'error',
279
292
  };
293
+ export const DescriptionType = {
294
+ PLAIN: 'plain',
295
+ MARKDOWN: 'markdown',
296
+ };
297
+ /**
298
+ * Constants representing the help text for
299
+ * each view.
300
+ */
301
+ export const ViewHelpMapping = {
302
+ SCATTERPLOT: 'The scatterplot displays two-dimensional (pre-computed) dimensionality reduction results (such as from t-SNE or UMAP). Each point on the scatterplot represents an observation (e.g., cell).',
303
+ HEATMAP: 'The heatmap displays an observation-by-feature (e.g., cell-by-gene) matrix, typically with transformed (e.g., normalized or standardized) values.',
304
+ SPATIAL: 'The spatial view displays (potentially layered) spatially-resolved data including RGB or multiplexed images, segmentations of observations (bitmask- or polygon-based), and/or points (e.g., representing FISH transcripts).',
305
+ DESCRIPTION: 'The description view displays additional information about a dataset. When images are included in a dataset, the description view also includes image metadata (if contained in the image files).',
306
+ STATUS: 'The status view displays debugging messages, including app-wide error messages when datasets fail to load or when schemas fail to validate. Details about the entity under the mouse cursor (cell, gene, and/or molecule) are displayed during hover interactions.',
307
+ LAYER_CONTROLLER: 'The spatial layer controller provides an interface for manipulating the visualization layers displayed in the spatial view.',
308
+ GENOMIC_PROFILES: 'The genomic profiles view displays genome browser tracks (using the genomic-profiles data type) containing bar plots, where the genome is along the x-axis and the value at each genome position is encoded with a bar along the y-axis.',
309
+ GATING: 'The gating scatterplot displays expression data for two genes (along the X and Y axes). Users can select two genes, and the scatterplot is dynamically generated using observation-by-feature matrix data. Gating can then be performed by using the lasso or box select tools.',
310
+ FEATURE_LIST: 'The feature list controller displays an interactive list of features (e.g., genes).',
311
+ OBS_SETS: 'The observation sets controller displays an interactive list of (potentially hierarchical) observation sets (e.g., cell clusters or cell type annotations).',
312
+ OBS_SET_SIZES: 'The observation set sizes view displays a bar plot with the currently-selected observation sets (e.g., cell types) on the x-axis and bars representing their size (e.g., number of cells) on the y-axis.',
313
+ OBS_SET_FEATURE_VALUE_DISTRIBUTION: 'The observation set feature value distribution view displays a violin plot with values (e.g., expression values) per set (e.g., cell type) for the selected feature (e.g., gene).',
314
+ FEATURE_VALUE_HISTOGRAM: 'The feature value histogram displays the distribution of values (e.g., expression) for the selected feature (e.g., gene).',
315
+ DOT_PLOT: 'The dot plot displays summary information about expression of the selected features (e.g., genes) for each selected observation set (e.g., cell type).',
316
+ FEATURE_BAR_PLOT: 'The feature bar plot displays one bar per observation (e.g., cell) along the x-axis, where the value of a selected feature (e.g., gene) is encoded along the y-axis.',
317
+ };
@@ -1,4 +1,4 @@
1
- export { ViewType, DataType, FileType, CoordinationType, STATUS, } from './constants.js';
1
+ export { ViewType, DataType, FileType, CoordinationType, STATUS, ViewHelpMapping, DescriptionType, } from './constants.js';
2
2
  export { FILE_TYPE_DATA_TYPE_MAPPING, DATA_TYPE_COORDINATION_VALUE_USAGE, ALT_ZARR_STORE_TYPES, } from './constant-relationships.js';
3
3
  export { AUTO_INDEPENDENT_COORDINATION_TYPES, COMPONENT_COORDINATION_TYPES } from './coordination.js';
4
4
  export { default as META_VERSION } from './version.json';
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,gBAAgB,EAAE,MAAM,GACvD,MAAM,gBAAgB,CAAC;AACxB,OAAO,EACL,2BAA2B,EAC3B,kCAAkC,EAClC,oBAAoB,GACrB,MAAM,6BAA6B,CAAC;AACrC,OAAO,EAAE,mCAAmC,EAAE,4BAA4B,EAAE,MAAM,mBAAmB,CAAC;AACtG,OAAO,EAAE,OAAO,IAAI,YAAY,EAAE,MAAM,gBAAgB,CAAC"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,gBAAgB,EAAE,MAAM,EAAE,eAAe,EAAE,eAAe,GACzF,MAAM,gBAAgB,CAAC;AACxB,OAAO,EACL,2BAA2B,EAC3B,kCAAkC,EAClC,oBAAoB,GACrB,MAAM,6BAA6B,CAAC;AACrC,OAAO,EAAE,mCAAmC,EAAE,4BAA4B,EAAE,MAAM,mBAAmB,CAAC;AACtG,OAAO,EAAE,OAAO,IAAI,YAAY,EAAE,MAAM,gBAAgB,CAAC"}
package/dist-tsc/index.js CHANGED
@@ -1,4 +1,4 @@
1
- export { ViewType, DataType, FileType, CoordinationType, STATUS, } from './constants.js';
1
+ export { ViewType, DataType, FileType, CoordinationType, STATUS, ViewHelpMapping, DescriptionType, } from './constants.js';
2
2
  export { FILE_TYPE_DATA_TYPE_MAPPING, DATA_TYPE_COORDINATION_VALUE_USAGE, ALT_ZARR_STORE_TYPES, } from './constant-relationships.js';
3
3
  export { AUTO_INDEPENDENT_COORDINATION_TYPES, COMPONENT_COORDINATION_TYPES } from './coordination.js';
4
4
  export { default as META_VERSION } from './version.json';
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "note": "This file is autogenerated by .changeset/post-changelog.mjs.",
3
- "version": "3.4.9",
4
- "date": "2024-07-26",
3
+ "version": "3.4.11",
4
+ "date": "2024-09-27",
5
5
  "branch": "changeset-release/main",
6
- "hash": "9582ddcf"
6
+ "hash": "efd7d698"
7
7
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@vitessce/constants-internal",
3
- "version": "3.4.9",
3
+ "version": "3.4.11",
4
4
  "author": "Gehlenborg Lab",
5
5
  "homepage": "http://vitessce.io",
6
6
  "repository": {
@@ -128,35 +128,46 @@ export const DATA_TYPE_COORDINATION_VALUE_USAGE = {
128
128
  export const ALT_ZARR_STORE_TYPES = {
129
129
  [FileType.OBS_FEATURE_MATRIX_ANNDATA_ZARR]: {
130
130
  zip: FileType.OBS_FEATURE_MATRIX_ANNDATA_ZARR_ZIP,
131
+ h5ad: FileType.OBS_FEATURE_MATRIX_ANNDATA_H5AD,
131
132
  },
132
133
  [FileType.OBS_FEATURE_COLUMNS_ANNDATA_ZARR]: {
133
134
  zip: FileType.OBS_FEATURE_COLUMNS_ANNDATA_ZARR_ZIP,
135
+ h5ad: FileType.OBS_FEATURE_COLUMNS_ANNDATA_H5AD,
134
136
  },
135
137
  [FileType.OBS_SETS_ANNDATA_ZARR]: {
136
138
  zip: FileType.OBS_SETS_ANNDATA_ZARR_ZIP,
139
+ h5ad: FileType.OBS_SETS_ANNDATA_H5AD,
137
140
  },
138
141
  [FileType.OBS_EMBEDDING_ANNDATA_ZARR]: {
139
142
  zip: FileType.OBS_EMBEDDING_ANNDATA_ZARR_ZIP,
143
+ h5ad: FileType.OBS_EMBEDDING_ANNDATA_H5AD,
140
144
  },
141
145
  [FileType.OBS_SPOTS_ANNDATA_ZARR]: {
142
146
  zip: FileType.OBS_SPOTS_ANNDATA_ZARR_ZIP,
147
+ h5ad: FileType.OBS_SPOTS_ANNDATA_H5AD,
143
148
  },
144
149
  [FileType.OBS_POINTS_ANNDATA_ZARR]: {
145
150
  zip: FileType.OBS_POINTS_ANNDATA_ZARR_ZIP,
151
+ h5ad: FileType.OBS_POINTS_ANNDATA_H5AD,
146
152
  },
147
153
  [FileType.OBS_LOCATIONS_ANNDATA_ZARR]: {
148
154
  zip: FileType.OBS_LOCATIONS_ANNDATA_ZARR_ZIP,
155
+ h5ad: FileType.OBS_LOCATIONS_ANNDATA_H5AD,
149
156
  },
150
157
  [FileType.OBS_SEGMENTATIONS_ANNDATA_ZARR]: {
151
158
  zip: FileType.OBS_SEGMENTATIONS_ANNDATA_ZARR_ZIP,
159
+ h5ad: FileType.OBS_SEGMENTATIONS_ANNDATA_H5AD,
152
160
  },
153
161
  [FileType.OBS_LABELS_ANNDATA_ZARR]: {
154
162
  zip: FileType.OBS_LABELS_ANNDATA_ZARR_ZIP,
163
+ h5ad: FileType.OBS_LABELS_ANNDATA_H5AD,
155
164
  },
156
165
  [FileType.FEATURE_LABELS_ANNDATA_ZARR]: {
157
166
  zip: FileType.FEATURE_LABELS_ANNDATA_ZARR_ZIP,
167
+ h5ad: FileType.FEATURE_LABELS_ANNDATA_H5AD,
158
168
  },
159
169
  [FileType.SAMPLE_EDGES_ANNDATA_ZARR]: {
160
170
  zip: FileType.SAMPLE_EDGES_ANNDATA_ZARR_ZIP,
171
+ h5ad: FileType.SAMPLE_EDGES_ANNDATA_H5AD,
161
172
  },
162
173
  };
package/src/constants.ts CHANGED
@@ -53,6 +53,7 @@ export const FileType = {
53
53
  // Joint file types
54
54
  ANNDATA_ZARR: 'anndata.zarr',
55
55
  ANNDATA_ZARR_ZIP: 'anndata.zarr.zip',
56
+ ANNDATA_H5AD: 'anndata.h5ad',
56
57
  SPATIALDATA_ZARR: 'spatialdata.zarr',
57
58
  // Atomic file types
58
59
  OBS_EMBEDDING_CSV: 'obsEmbedding.csv',
@@ -93,6 +94,18 @@ export const FileType = {
93
94
  OBS_LABELS_ANNDATA_ZARR_ZIP: 'obsLabels.anndata.zarr.zip',
94
95
  FEATURE_LABELS_ANNDATA_ZARR_ZIP: 'featureLabels.anndata.zarr.zip',
95
96
  SAMPLE_EDGES_ANNDATA_ZARR_ZIP: 'sampleEdges.anndata.zarr.zip',
97
+ // AnnData - h5ad via reference spec
98
+ OBS_FEATURE_MATRIX_ANNDATA_H5AD: 'obsFeatureMatrix.anndata.h5ad',
99
+ OBS_FEATURE_COLUMNS_ANNDATA_H5AD: 'obsFeatureColumns.anndata.h5ad',
100
+ OBS_SETS_ANNDATA_H5AD: 'obsSets.anndata.h5ad',
101
+ OBS_EMBEDDING_ANNDATA_H5AD: 'obsEmbedding.anndata.h5ad',
102
+ OBS_SPOTS_ANNDATA_H5AD: 'obsSpots.anndata.h5ad',
103
+ OBS_POINTS_ANNDATA_H5AD: 'obsPoints.anndata.h5ad',
104
+ OBS_LOCATIONS_ANNDATA_H5AD: 'obsLocations.anndata.h5ad',
105
+ OBS_SEGMENTATIONS_ANNDATA_H5AD: 'obsSegmentations.anndata.h5ad',
106
+ OBS_LABELS_ANNDATA_H5AD: 'obsLabels.anndata.h5ad',
107
+ FEATURE_LABELS_ANNDATA_H5AD: 'featureLabels.anndata.h5ad',
108
+ SAMPLE_EDGES_ANNDATA_H5AD: 'sampleEdges.anndata.h5ad',
96
109
  // SpatialData
97
110
  IMAGE_SPATIALDATA_ZARR: 'image.spatialdata.zarr',
98
111
  LABELS_SPATIALDATA_ZARR: 'labels.spatialdata.zarr',
@@ -283,3 +296,30 @@ export const STATUS = {
283
296
  SUCCESS: 'success',
284
297
  ERROR: 'error',
285
298
  };
299
+
300
+ export const DescriptionType = {
301
+ PLAIN: 'plain',
302
+ MARKDOWN: 'markdown',
303
+ };
304
+
305
+ /**
306
+ * Constants representing the help text for
307
+ * each view.
308
+ */
309
+ export const ViewHelpMapping = {
310
+ SCATTERPLOT: 'The scatterplot displays two-dimensional (pre-computed) dimensionality reduction results (such as from t-SNE or UMAP). Each point on the scatterplot represents an observation (e.g., cell).',
311
+ HEATMAP: 'The heatmap displays an observation-by-feature (e.g., cell-by-gene) matrix, typically with transformed (e.g., normalized or standardized) values.',
312
+ SPATIAL: 'The spatial view displays (potentially layered) spatially-resolved data including RGB or multiplexed images, segmentations of observations (bitmask- or polygon-based), and/or points (e.g., representing FISH transcripts).',
313
+ DESCRIPTION: 'The description view displays additional information about a dataset. When images are included in a dataset, the description view also includes image metadata (if contained in the image files).',
314
+ STATUS: 'The status view displays debugging messages, including app-wide error messages when datasets fail to load or when schemas fail to validate. Details about the entity under the mouse cursor (cell, gene, and/or molecule) are displayed during hover interactions.',
315
+ LAYER_CONTROLLER: 'The spatial layer controller provides an interface for manipulating the visualization layers displayed in the spatial view.',
316
+ GENOMIC_PROFILES: 'The genomic profiles view displays genome browser tracks (using the genomic-profiles data type) containing bar plots, where the genome is along the x-axis and the value at each genome position is encoded with a bar along the y-axis.',
317
+ GATING: 'The gating scatterplot displays expression data for two genes (along the X and Y axes). Users can select two genes, and the scatterplot is dynamically generated using observation-by-feature matrix data. Gating can then be performed by using the lasso or box select tools.',
318
+ FEATURE_LIST: 'The feature list controller displays an interactive list of features (e.g., genes).',
319
+ OBS_SETS: 'The observation sets controller displays an interactive list of (potentially hierarchical) observation sets (e.g., cell clusters or cell type annotations).',
320
+ OBS_SET_SIZES: 'The observation set sizes view displays a bar plot with the currently-selected observation sets (e.g., cell types) on the x-axis and bars representing their size (e.g., number of cells) on the y-axis.',
321
+ OBS_SET_FEATURE_VALUE_DISTRIBUTION: 'The observation set feature value distribution view displays a violin plot with values (e.g., expression values) per set (e.g., cell type) for the selected feature (e.g., gene).',
322
+ FEATURE_VALUE_HISTOGRAM: 'The feature value histogram displays the distribution of values (e.g., expression) for the selected feature (e.g., gene).',
323
+ DOT_PLOT: 'The dot plot displays summary information about expression of the selected features (e.g., genes) for each selected observation set (e.g., cell type).',
324
+ FEATURE_BAR_PLOT: 'The feature bar plot displays one bar per observation (e.g., cell) along the x-axis, where the value of a selected feature (e.g., gene) is encoded along the y-axis.',
325
+ };
package/src/index.ts CHANGED
@@ -1,5 +1,5 @@
1
1
  export {
2
- ViewType, DataType, FileType, CoordinationType, STATUS,
2
+ ViewType, DataType, FileType, CoordinationType, STATUS, ViewHelpMapping, DescriptionType,
3
3
  } from './constants.js';
4
4
  export {
5
5
  FILE_TYPE_DATA_TYPE_MAPPING,
package/src/version.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "note": "This file is autogenerated by .changeset/post-changelog.mjs.",
3
- "version": "3.4.9",
4
- "date": "2024-07-26",
3
+ "version": "3.4.11",
4
+ "date": "2024-09-27",
5
5
  "branch": "changeset-release/main",
6
- "hash": "9582ddcf"
6
+ "hash": "efd7d698"
7
7
  }