@abi-software/map-side-bar 1.3.26-staging → 1.3.26
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/README.md +93 -0
- package/dist/map-side-bar.common.js +157 -380
- package/dist/map-side-bar.common.js.map +1 -1
- package/dist/map-side-bar.css +1 -1
- package/dist/map-side-bar.umd.js +157 -380
- package/dist/map-side-bar.umd.js.map +1 -1
- package/dist/map-side-bar.umd.min.js +1 -1
- package/dist/map-side-bar.umd.min.js.map +1 -1
- package/package-lock.json +1 -1
- package/package.json +1 -1
- package/src/algolia/algolia.js +13 -13
- package/src/components/ContextCard.vue +12 -5
- package/src/components/DatasetCard.vue +7 -67
- package/src/components/ImageGallery.vue +11 -5
- package/src/components/SidebarContent.vue +3 -6
- package/dist/img/logo-sparc-wave-primary.8ed83a51.svg +0 -1
- package/src/mixins/GalleryHelpers.js +0 -104
package/README.md
CHANGED
|
@@ -51,3 +51,96 @@ envVars contains environment varibables like so:
|
|
|
51
51
|
```
|
|
52
52
|
|
|
53
53
|
actionClick event is called when an action button has benn clicked on.
|
|
54
|
+
|
|
55
|
+
|
|
56
|
+
## Sidebar Data formats
|
|
57
|
+
### Algolia
|
|
58
|
+
|
|
59
|
+
Data retrieved from Algolia can be found here:
|
|
60
|
+
https://github.com/ABI-Software/map-sidebar/blob/3310b165489b10901f50a21e5689ef046251dbd9/src/algolia/algolia.js#L136
|
|
61
|
+
|
|
62
|
+
```
|
|
63
|
+
[
|
|
64
|
+
'pennsieve.publishDate', // optional
|
|
65
|
+
'pennsieve.updatedAt', // optional
|
|
66
|
+
'Item.curie', //contains the DOI for the dataset (required)
|
|
67
|
+
'Item.name', // dataset title (required)
|
|
68
|
+
'Item.description', // dataset description (required)
|
|
69
|
+
'objectID', // Pennsieve discover ID (required)
|
|
70
|
+
],
|
|
71
|
+
```
|
|
72
|
+
|
|
73
|
+
### Scicrunch
|
|
74
|
+
|
|
75
|
+
Data retrieved from scicrunch can be found here:
|
|
76
|
+
https://github.com/nih-sparc/sparc-api/blob/f3444a32964f5340e0ee1f10a08a05839620d098/app/scicrunch_processing_common.py#L25
|
|
77
|
+
|
|
78
|
+
And mimetypes can be viewed here
|
|
79
|
+
https://github.com/nih-sparc/sparc-api/blob/f3444a32964f5340e0ee1f10a08a05839620d098/app/scicrunch_processing_common.py#L28
|
|
80
|
+
|
|
81
|
+
```
|
|
82
|
+
ADDITIONAL_LINKS = 'additionalLinks'
|
|
83
|
+
BIOLUCIDA_2D = 'biolucida-2d'
|
|
84
|
+
BIOLUCIDA_3D = 'biolucida-3d'
|
|
85
|
+
COMMON_IMAGES = 'common-images'
|
|
86
|
+
CONTEXT_FILE = 'abi-context-file'
|
|
87
|
+
CSV = 'csv'
|
|
88
|
+
NAME = 'name'
|
|
89
|
+
ORGANS = 'organs'
|
|
90
|
+
PLOT_FILE = 'abi-plot'
|
|
91
|
+
SEGMENTATION_FILES = 'mbf-segmentation'
|
|
92
|
+
SCAFFOLD_DIR = 'abi-scaffold-dir'
|
|
93
|
+
SCAFFOLD_FILE = 'abi-scaffold-metadata-file'
|
|
94
|
+
THUMBNAIL_IMAGE = 'abi-thumbnail'
|
|
95
|
+
SCAFFOLD_VIEW_FILE = 'abi-scaffold-view-file'
|
|
96
|
+
SIMULATION_FILE = 'abi-simulation-file'
|
|
97
|
+
VIDEO = 'video'
|
|
98
|
+
VERSION = 'version'
|
|
99
|
+
README = 'readme'
|
|
100
|
+
TITLE = 'title'
|
|
101
|
+
```
|
|
102
|
+
|
|
103
|
+
Note: All are optional except for ‘name’
|
|
104
|
+
|
|
105
|
+
### Sidebar input processing
|
|
106
|
+
Sidebar input processing can be viewed here:
|
|
107
|
+
https://github.com/ABI-Software/map-sidebar/blob/3310b165489b10901f50a21e5689ef046251dbd9/src/components/SidebarContent.vue#L318
|
|
108
|
+
|
|
109
|
+
It is used to keep the code from attempting to access an object property that does not exist
|
|
110
|
+
|
|
111
|
+
### Context card data format
|
|
112
|
+
All fields are strings:
|
|
113
|
+
```
|
|
114
|
+
{
|
|
115
|
+
"description": required ,
|
|
116
|
+
"id": optional,
|
|
117
|
+
"samples": [ // array required here (can be empty)
|
|
118
|
+
{
|
|
119
|
+
"annotation": optional,
|
|
120
|
+
"description": required,
|
|
121
|
+
"doi": optional // Doi will be used to link sample to a separate dataset,
|
|
122
|
+
"heading": required,
|
|
123
|
+
"id": required,
|
|
124
|
+
"path": optional // path will be used to link to file location,
|
|
125
|
+
"view": optional // Will be used to link to “views[i].id”
|
|
126
|
+
}
|
|
127
|
+
],
|
|
128
|
+
"version": // not currently used,
|
|
129
|
+
"views": [ // array required here (can be empty)
|
|
130
|
+
{
|
|
131
|
+
"annotation": optional,
|
|
132
|
+
"description": required,
|
|
133
|
+
"id": requried,
|
|
134
|
+
"path": required // relative path to the view file, eg "derivative\\Scaffolds\\scaffoldMap_tenial_view.json",
|
|
135
|
+
"sample": optional // used to link to views to samples
|
|
136
|
+
"thumbnail": optional // technically optional but it won’t look great
|
|
137
|
+
}
|
|
138
|
+
]
|
|
139
|
+
}
|
|
140
|
+
```
|
|
141
|
+
|
|
142
|
+
An example context card file can be viewed here:
|
|
143
|
+
https://drive.google.com/file/d/15NVRBny7WGltpMSRbsgMglXo0xOC3-Q9/view?usp=sharing
|
|
144
|
+
|
|
145
|
+
|
|
146
|
+
|