galaxy-charts 0.0.21 → 0.0.23

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 (94) hide show
  1. package/dist/galaxy-charts.css +1 -0
  2. package/dist/galaxy-charts.js +21275 -0
  3. package/dist/galaxy-charts.umd.cjs +2073 -0
  4. package/{src/types.ts → dist/types.d.ts} +8 -7
  5. package/package.json +7 -1
  6. package/.github/workflows/main.yml +0 -64
  7. package/.vscode/extensions.json +0 -3
  8. package/docs/.vitepress/cache/deps/_metadata.json +0 -40
  9. package/docs/.vitepress/cache/deps/chunk-G3PMV62Z.js +0 -36
  10. package/docs/.vitepress/cache/deps/chunk-G3PMV62Z.js.map +0 -7
  11. package/docs/.vitepress/cache/deps/chunk-XYSSNQS4.js +0 -12492
  12. package/docs/.vitepress/cache/deps/chunk-XYSSNQS4.js.map +0 -7
  13. package/docs/.vitepress/cache/deps/naive-ui.js +0 -107113
  14. package/docs/.vitepress/cache/deps/naive-ui.js.map +0 -7
  15. package/docs/.vitepress/cache/deps/package.json +0 -3
  16. package/docs/.vitepress/cache/deps/vitepress___@vue_devtools-api.js +0 -4494
  17. package/docs/.vitepress/cache/deps/vitepress___@vue_devtools-api.js.map +0 -7
  18. package/docs/.vitepress/cache/deps/vitepress___@vueuse_core.js +0 -9345
  19. package/docs/.vitepress/cache/deps/vitepress___@vueuse_core.js.map +0 -7
  20. package/docs/.vitepress/cache/deps/vue.js +0 -344
  21. package/docs/.vitepress/cache/deps/vue.js.map +0 -7
  22. package/docs/.vitepress/config.mts +0 -55
  23. package/docs/.vitepress/theme/index.js +0 -7
  24. package/docs/.vitepress/theme/tailwind.css +0 -7
  25. package/docs/content/configuration.md +0 -45
  26. package/docs/content/deploy-plugin.md +0 -22
  27. package/docs/content/deploy-request.md +0 -65
  28. package/docs/content/installation.md +0 -42
  29. package/docs/content/introduction.md +0 -45
  30. package/docs/content/vue-introduction.md +0 -38
  31. package/docs/content/vue-utilities.md +0 -70
  32. package/docs/content/xml-datasources.md +0 -34
  33. package/docs/content/xml-framework.md +0 -140
  34. package/docs/content/xml-inputs.md +0 -248
  35. package/docs/content/xml-introduction.md +0 -23
  36. package/docs/content/xml-sections.md +0 -50
  37. package/docs/index.md +0 -27
  38. package/docs/package-lock.json +0 -4203
  39. package/docs/package.json +0 -21
  40. package/docs/postcss.config.js +0 -6
  41. package/docs/public/eslint.svg +0 -7
  42. package/docs/public/galaxy-charts-demo.gif +0 -0
  43. package/docs/public/galaxy-charts-starter.jpg +0 -0
  44. package/docs/public/galaxy-charts.svg +0 -7
  45. package/docs/public/javascript.svg +0 -8
  46. package/docs/public/naive-ui.svg +0 -9
  47. package/docs/public/next-js.svg +0 -25
  48. package/docs/public/nuxt.svg +0 -3
  49. package/docs/public/prettier.svg +0 -46
  50. package/docs/public/react.svg +0 -1
  51. package/docs/public/tailwind.svg +0 -12
  52. package/docs/public/typescript.svg +0 -8
  53. package/docs/public/vite.svg +0 -15
  54. package/docs/public/vitest.svg +0 -9
  55. package/docs/public/vue.svg +0 -8
  56. package/docs/public/vuetify.svg +0 -9
  57. package/docs/tailwind.config.js +0 -9
  58. package/index.html +0 -13
  59. package/lib/galaxy-charts.js +0 -7
  60. package/postcss.config.js +0 -6
  61. package/prettier.config.js +0 -5
  62. package/public/galaxy-charts.xml +0 -138
  63. package/src/App.vue +0 -23
  64. package/src/Plugin.vue +0 -37
  65. package/src/api/client.ts +0 -46
  66. package/src/api/datasets.ts +0 -34
  67. package/src/api/visualizations.ts +0 -33
  68. package/src/components/AlertNotify.vue +0 -35
  69. package/src/components/ApiStatus.vue +0 -39
  70. package/src/components/GalaxyCharts.vue +0 -136
  71. package/src/components/InputConditional.vue +0 -109
  72. package/src/components/InputData.vue +0 -74
  73. package/src/components/InputDataColumn.vue +0 -54
  74. package/src/components/InputForm.vue +0 -119
  75. package/src/components/InputRepeats.vue +0 -70
  76. package/src/components/SidePanel.vue +0 -158
  77. package/src/main.js +0 -27
  78. package/src/store/columnsStore.ts +0 -59
  79. package/src/store/configStore.ts +0 -29
  80. package/src/style.css +0 -3
  81. package/src/utilities/getFileName.test.js +0 -8
  82. package/src/utilities/getFileName.ts +0 -4
  83. package/src/utilities/parseColumns.ts +0 -34
  84. package/src/utilities/parseDefaults.test.js +0 -13
  85. package/src/utilities/parseDefaults.ts +0 -17
  86. package/src/utilities/parseIncoming.ts +0 -32
  87. package/src/utilities/parsePlugin.ts +0 -95
  88. package/src/utilities/parseXML.ts +0 -156
  89. package/src/utilities/simpleError.ts +0 -21
  90. package/src/utilities/toBoolean.test.js +0 -12
  91. package/src/utilities/toBoolean.ts +0 -5
  92. package/tailwind.config.js +0 -8
  93. package/tsconfig.json +0 -28
  94. package/vite.config.js +0 -70
@@ -1,344 +0,0 @@
1
- import {
2
- BaseTransition,
3
- BaseTransitionPropsValidators,
4
- Comment,
5
- DeprecationTypes,
6
- EffectScope,
7
- ErrorCodes,
8
- ErrorTypeStrings,
9
- Fragment,
10
- KeepAlive,
11
- ReactiveEffect,
12
- Static,
13
- Suspense,
14
- Teleport,
15
- Text,
16
- TrackOpTypes,
17
- Transition,
18
- TransitionGroup,
19
- TriggerOpTypes,
20
- VueElement,
21
- assertNumber,
22
- callWithAsyncErrorHandling,
23
- callWithErrorHandling,
24
- camelize,
25
- capitalize,
26
- cloneVNode,
27
- compatUtils,
28
- compile,
29
- computed,
30
- createApp,
31
- createBaseVNode,
32
- createBlock,
33
- createCommentVNode,
34
- createElementBlock,
35
- createHydrationRenderer,
36
- createPropsRestProxy,
37
- createRenderer,
38
- createSSRApp,
39
- createSlots,
40
- createStaticVNode,
41
- createTextVNode,
42
- createVNode,
43
- customRef,
44
- defineAsyncComponent,
45
- defineComponent,
46
- defineCustomElement,
47
- defineEmits,
48
- defineExpose,
49
- defineModel,
50
- defineOptions,
51
- defineProps,
52
- defineSSRCustomElement,
53
- defineSlots,
54
- devtools,
55
- effect,
56
- effectScope,
57
- getCurrentInstance,
58
- getCurrentScope,
59
- getCurrentWatcher,
60
- getTransitionRawChildren,
61
- guardReactiveProps,
62
- h,
63
- handleError,
64
- hasInjectionContext,
65
- hydrate,
66
- hydrateOnIdle,
67
- hydrateOnInteraction,
68
- hydrateOnMediaQuery,
69
- hydrateOnVisible,
70
- initCustomFormatter,
71
- initDirectivesForSSR,
72
- inject,
73
- isMemoSame,
74
- isProxy,
75
- isReactive,
76
- isReadonly,
77
- isRef,
78
- isRuntimeOnly,
79
- isShallow,
80
- isVNode,
81
- markRaw,
82
- mergeDefaults,
83
- mergeModels,
84
- mergeProps,
85
- nextTick,
86
- normalizeClass,
87
- normalizeProps,
88
- normalizeStyle,
89
- onActivated,
90
- onBeforeMount,
91
- onBeforeUnmount,
92
- onBeforeUpdate,
93
- onDeactivated,
94
- onErrorCaptured,
95
- onMounted,
96
- onRenderTracked,
97
- onRenderTriggered,
98
- onScopeDispose,
99
- onServerPrefetch,
100
- onUnmounted,
101
- onUpdated,
102
- onWatcherCleanup,
103
- openBlock,
104
- popScopeId,
105
- provide,
106
- proxyRefs,
107
- pushScopeId,
108
- queuePostFlushCb,
109
- reactive,
110
- readonly,
111
- ref,
112
- registerRuntimeCompiler,
113
- render,
114
- renderList,
115
- renderSlot,
116
- resolveComponent,
117
- resolveDirective,
118
- resolveDynamicComponent,
119
- resolveFilter,
120
- resolveTransitionHooks,
121
- setBlockTracking,
122
- setDevtoolsHook,
123
- setTransitionHooks,
124
- shallowReactive,
125
- shallowReadonly,
126
- shallowRef,
127
- ssrContextKey,
128
- ssrUtils,
129
- stop,
130
- toDisplayString,
131
- toHandlerKey,
132
- toHandlers,
133
- toRaw,
134
- toRef,
135
- toRefs,
136
- toValue,
137
- transformVNodeArgs,
138
- triggerRef,
139
- unref,
140
- useAttrs,
141
- useCssModule,
142
- useCssVars,
143
- useHost,
144
- useId,
145
- useModel,
146
- useSSRContext,
147
- useShadowRoot,
148
- useSlots,
149
- useTemplateRef,
150
- useTransitionState,
151
- vModelCheckbox,
152
- vModelDynamic,
153
- vModelRadio,
154
- vModelSelect,
155
- vModelText,
156
- vShow,
157
- version,
158
- warn,
159
- watch,
160
- watchEffect,
161
- watchPostEffect,
162
- watchSyncEffect,
163
- withAsyncContext,
164
- withCtx,
165
- withDefaults,
166
- withDirectives,
167
- withKeys,
168
- withMemo,
169
- withModifiers,
170
- withScopeId
171
- } from "./chunk-XYSSNQS4.js";
172
- import "./chunk-G3PMV62Z.js";
173
- export {
174
- BaseTransition,
175
- BaseTransitionPropsValidators,
176
- Comment,
177
- DeprecationTypes,
178
- EffectScope,
179
- ErrorCodes,
180
- ErrorTypeStrings,
181
- Fragment,
182
- KeepAlive,
183
- ReactiveEffect,
184
- Static,
185
- Suspense,
186
- Teleport,
187
- Text,
188
- TrackOpTypes,
189
- Transition,
190
- TransitionGroup,
191
- TriggerOpTypes,
192
- VueElement,
193
- assertNumber,
194
- callWithAsyncErrorHandling,
195
- callWithErrorHandling,
196
- camelize,
197
- capitalize,
198
- cloneVNode,
199
- compatUtils,
200
- compile,
201
- computed,
202
- createApp,
203
- createBlock,
204
- createCommentVNode,
205
- createElementBlock,
206
- createBaseVNode as createElementVNode,
207
- createHydrationRenderer,
208
- createPropsRestProxy,
209
- createRenderer,
210
- createSSRApp,
211
- createSlots,
212
- createStaticVNode,
213
- createTextVNode,
214
- createVNode,
215
- customRef,
216
- defineAsyncComponent,
217
- defineComponent,
218
- defineCustomElement,
219
- defineEmits,
220
- defineExpose,
221
- defineModel,
222
- defineOptions,
223
- defineProps,
224
- defineSSRCustomElement,
225
- defineSlots,
226
- devtools,
227
- effect,
228
- effectScope,
229
- getCurrentInstance,
230
- getCurrentScope,
231
- getCurrentWatcher,
232
- getTransitionRawChildren,
233
- guardReactiveProps,
234
- h,
235
- handleError,
236
- hasInjectionContext,
237
- hydrate,
238
- hydrateOnIdle,
239
- hydrateOnInteraction,
240
- hydrateOnMediaQuery,
241
- hydrateOnVisible,
242
- initCustomFormatter,
243
- initDirectivesForSSR,
244
- inject,
245
- isMemoSame,
246
- isProxy,
247
- isReactive,
248
- isReadonly,
249
- isRef,
250
- isRuntimeOnly,
251
- isShallow,
252
- isVNode,
253
- markRaw,
254
- mergeDefaults,
255
- mergeModels,
256
- mergeProps,
257
- nextTick,
258
- normalizeClass,
259
- normalizeProps,
260
- normalizeStyle,
261
- onActivated,
262
- onBeforeMount,
263
- onBeforeUnmount,
264
- onBeforeUpdate,
265
- onDeactivated,
266
- onErrorCaptured,
267
- onMounted,
268
- onRenderTracked,
269
- onRenderTriggered,
270
- onScopeDispose,
271
- onServerPrefetch,
272
- onUnmounted,
273
- onUpdated,
274
- onWatcherCleanup,
275
- openBlock,
276
- popScopeId,
277
- provide,
278
- proxyRefs,
279
- pushScopeId,
280
- queuePostFlushCb,
281
- reactive,
282
- readonly,
283
- ref,
284
- registerRuntimeCompiler,
285
- render,
286
- renderList,
287
- renderSlot,
288
- resolveComponent,
289
- resolveDirective,
290
- resolveDynamicComponent,
291
- resolveFilter,
292
- resolveTransitionHooks,
293
- setBlockTracking,
294
- setDevtoolsHook,
295
- setTransitionHooks,
296
- shallowReactive,
297
- shallowReadonly,
298
- shallowRef,
299
- ssrContextKey,
300
- ssrUtils,
301
- stop,
302
- toDisplayString,
303
- toHandlerKey,
304
- toHandlers,
305
- toRaw,
306
- toRef,
307
- toRefs,
308
- toValue,
309
- transformVNodeArgs,
310
- triggerRef,
311
- unref,
312
- useAttrs,
313
- useCssModule,
314
- useCssVars,
315
- useHost,
316
- useId,
317
- useModel,
318
- useSSRContext,
319
- useShadowRoot,
320
- useSlots,
321
- useTemplateRef,
322
- useTransitionState,
323
- vModelCheckbox,
324
- vModelDynamic,
325
- vModelRadio,
326
- vModelSelect,
327
- vModelText,
328
- vShow,
329
- version,
330
- warn,
331
- watch,
332
- watchEffect,
333
- watchPostEffect,
334
- watchSyncEffect,
335
- withAsyncContext,
336
- withCtx,
337
- withDefaults,
338
- withDirectives,
339
- withKeys,
340
- withMemo,
341
- withModifiers,
342
- withScopeId
343
- };
344
- //# sourceMappingURL=vue.js.map
@@ -1,7 +0,0 @@
1
- {
2
- "version": 3,
3
- "sources": [],
4
- "sourcesContent": [],
5
- "mappings": "",
6
- "names": []
7
- }
@@ -1,55 +0,0 @@
1
- import { defineConfig } from 'vitepress'
2
-
3
- // https://vitepress.dev/reference/site-config
4
- export default defineConfig({
5
- appearance: "dark",
6
- base: "/galaxy-charts/",
7
- title: "Galaxy Charts",
8
- description: "Documentation for Galaxy Charts",
9
- themeConfig: {
10
- // https://vitepress.dev/reference/default-theme-config
11
- logo: '/galaxy-charts.svg',
12
- nav: [
13
- { text: 'Home', link: '/' },
14
- ],
15
-
16
- sidebar: [
17
- {
18
- text: 'Introduction',
19
- items: [
20
- { text: 'What is Galaxy Charts?', link: '/content/introduction' },
21
- { text: 'Getting Started', link: '/content/installation' },
22
- { text: 'Connect to Galaxy', link: '/content/configuration' },
23
- ]
24
- },
25
- {
26
- text: 'XML Wrapper',
27
- items: [
28
- { text: 'Introduction', link: '/content/xml-introduction' },
29
- { text: 'Framework', link: '/content/xml-framework' },
30
- { text: 'Data Sources', link: '/content/xml-datasources' },
31
- { text: 'Sections', link: '/content/xml-sections' },
32
- { text: 'Inputs', link: '/content/xml-inputs' },
33
- ]
34
- },
35
- {
36
- text: 'Vue Component',
37
- items: [
38
- { text: 'Introduction', link: '/content/vue-introduction' },
39
- { text: 'Utilities', link: '/content/vue-utilities' }
40
- ]
41
- },
42
- {
43
- text: 'Deploy to Galaxy',
44
- items: [
45
- { text: 'Build and Publish', link: '/content/deploy-plugin' },
46
- { text: 'Submit Pull Request', link: '/content/deploy-request' },
47
- ]
48
- },
49
- ],
50
-
51
- socialLinks: [
52
- { icon: 'github', link: 'https://github.com/galaxyproject/galaxy-charts' }
53
- ]
54
- }
55
- })
@@ -1,7 +0,0 @@
1
- // docs/.vitepress/theme/index.js or index.ts
2
- import DefaultTheme from 'vitepress/theme'
3
- import './tailwind.css' // Ensure this file exists and includes your Tailwind imports
4
-
5
- export default {
6
- ...DefaultTheme,
7
- }
@@ -1,7 +0,0 @@
1
- @tailwind base;
2
- @tailwind components;
3
- @tailwind utilities;
4
-
5
- .VPNavBarTitle a span {
6
- color: #E30A17;
7
- }
@@ -1,45 +0,0 @@
1
- # Connect to Galaxy
2
-
3
- Galaxy Charts can be used to develop visualizations independently of Galaxy. However, to access Galaxy datasets, metadata, or run jobs, the visualization may need to connect to the Galaxy API.
4
-
5
- To connect the Galaxy Charts standalone application to a Galaxy instance (either local or public), provide the following environment variables when running Galaxy Charts:
6
-
7
- - **`GALAXY_KEY`**: Your Galaxy API key.
8
- - **`GALAXY_ROOT`**: The Galaxy server URL e.g. `https://usegalaxy.org` for Galaxy main.
9
-
10
- Run the following command, replacing `MY_API_KEY` and `MY_GALAXY_SERVER` with your own values:
11
-
12
- ```bash
13
- GALAXY_KEY=MY_API_KEY GALAXY_ROOT=MY_GALAXY_SERVER npm run dev
14
- ```
15
-
16
- ## Making Requests to the Galaxy API
17
-
18
- Once connected to Galaxy, you can make API requests by importing `GalaxyApi` as follows:
19
-
20
- ```javascript
21
- import { GalaxyApi } from "galaxy-charts";
22
-
23
- async function fetchGalaxyVersion() {
24
- try {
25
- const { response, data } = await GalaxyApi().GET("/api/version");
26
- console.log("API Version:", data);
27
- } catch (error) {
28
- console.error("Error fetching Galaxy version:", error);
29
- }
30
- }
31
-
32
- fetchGalaxyVersion();
33
- ```
34
-
35
- `GalaxyApi` supports `GET`, `POST` and `PUT` requests.
36
-
37
- ## How to Obtain an API Key
38
-
39
- 1. Go to your Galaxy instance and sign in.
40
- 2. Click on your username in the top navigation bar, then select **Preferences**.
41
- 3. Scroll down to the **Manage API Key** section to create and access your personal API key.
42
-
43
- ::: warning NOTE
44
- Keep your API key secure, just like your login credentials.
45
- :::
@@ -1,22 +0,0 @@
1
- ---
2
- outline: deep
3
- ---
4
-
5
- # Building and Publishing Your Visualization
6
-
7
- Once your visualization is complete and ready for deployment to Galaxy, you can publish it to `npm` and [submit a pull](deploy-request) request to the Galaxy development repository.
8
-
9
- ## Configure the Package Name
10
-
11
- 1. Open the `package.json` file in your project.
12
- 2. Update the `name` field to specify a unique package name.
13
- 3. Adjust the `version` field if needed.
14
-
15
- ## Build and Publish to npm
16
-
17
- To build and publish your package to `npm`, run the following commands from your project’s root directory:
18
-
19
- ```bash
20
- npm run build
21
- npm publish
22
- ```
@@ -1,65 +0,0 @@
1
- ---
2
- outline: deep
3
- ---
4
-
5
- # Submit a Pull Request to Galaxy
6
-
7
- With your visualization published to `npm`, the next step is to submit a pull request to the Galaxy development repository. This pull request should include your XML wrapper file and, optionally, a logo file in `png` format.
8
-
9
- Note: Replace `MY_VISUALIZATION` with your visualization name in the following instructions.
10
-
11
- ## Step 1: Fork and Clone the Galaxy Repository
12
-
13
- Fork the Galaxy repository available at [Galaxy Project on GitHub](https://github.com/galaxyproject/galaxy) and clone it to your local machine.
14
-
15
- ## Step 2: Create a Branch for Your Visualization
16
-
17
- Create a new branch specifically for your visualization:
18
-
19
- ```bash
20
- git branch MY_VISUALIZATION
21
- git checkout MY_VISUALIZATION
22
- ```
23
-
24
- ## Step 3: Set Up Your Visualization Directory
25
-
26
- 1. Create a directory for your visualization in the Galaxy repository at `config/plugins/visualizations/MY_VISUALIZATION`.
27
-
28
- 2. Copy the XML file (`MY_VISUALIZATION.xml`) generated during development into a subdirectory named config:
29
-
30
- ```plaintext
31
- config/plugins/visualizations/MY_VISUALIZATION/config/MY_VISUALIZATION.xml
32
- ```
33
-
34
- ## Step 4: Verify XML Requirements and Data Sources
35
-
36
- 1. Ensure the `requirements` section in your XML file specifies the correct `npm` package name and version.
37
- 2. Confirm the `data_sources` section in the XML lists the appropriate datatype extension(s) compatible with your visualization.
38
-
39
- ## Step 5: Add an Optional Logo
40
-
41
- Optionally, include a logo file (logo.png) for your visualization by placing it in a static subdirectory:
42
-
43
- ```plaintext
44
- config/plugins/visualizations/MY_VISUALIZATION/static/logo.png
45
- ```
46
-
47
- ## Step 6: Update the Gulpfile
48
-
49
- In the Galaxy root directory, open `client/gulpfile.js` and add the name of your visualization to the `INSTALL_PLUGIN_BUILD_IDS` list.
50
-
51
- ## Step 7: Run Galaxy and Test Your Visualization
52
-
53
- 1. **Start Galaxy** by running the following command:
54
-
55
- ```bash
56
- ./run.sh
57
- ```
58
-
59
- 2. **Upload a test file** to your Galaxy history, ensuring it has the correct data type for your visualization.
60
-
61
- 3. **Open your visualization** from the Activity Bar to view and test your uploaded dataset.
62
-
63
- ## :tada: Thank you for your contribution!
64
-
65
- Following these steps will prepare your visualization for integration with Galaxy. Once everything is set up, you can submit your pull request.
@@ -1,42 +0,0 @@
1
- # Getting Started
2
-
3
- Follow these steps to start developing a new visualization for Galaxy.
4
-
5
- ## 1. Set Up Your Repository
6
-
7
- 1. Sign in to your [GitHub](https://github.com) account.
8
- 2. Go to the [Galaxy Charts Starter](https://github.com/guerler/galaxy-charts-starter) repository.
9
- 3. Click on **Use this template** and select **Create a new repository**.
10
- 4. Name your new repository (e.g., `MY_VISUALIZATION`), then complete the setup by clicking **Create repository**.
11
-
12
- ## 2. Clone Your Repository
13
-
14
- Open a terminal window and clone your newly created repository:
15
-
16
- ```bash
17
- git clone https://github.com/USERNAME/MY_VISUALIZATION
18
- ```
19
- Replace USERNAME with your GitHub username and MY_VISUALIZATION with your repository name.
20
-
21
- ## 3. Initialize Your Visualization Project
22
-
23
- Navigate to your project directory and set up the environment:
24
- ```bash
25
- cd MY_VISUALIZATION
26
- npm install
27
- npm run dev
28
- ```
29
-
30
- ## 4. Next Steps
31
-
32
- Open a web browser and navigate to the localhost URL displayed in your terminal (typically in the format `http://localhost:PORT`):
33
-
34
- <div class="flex justify-around items-center p-1">
35
- <img class="border-2 rounded border-gray-100" src="/galaxy-charts-starter.jpg" alt="starter" width="80%">
36
- </div>
37
-
38
- Congratulations! Your Galaxy visualization repository is set up and ready for development. Follow the instructions on the splash screen and refer to these docs as you build your custom visualization.
39
-
40
- When you’re ready to publish, refer to the [Deploy to Galaxy](deploy-plugin.html) section to share your visualization with the Galaxy community.
41
-
42
- Thank you for your contribution!
@@ -1,45 +0,0 @@
1
- ---
2
- outline: deep
3
- ---
4
-
5
- # What is Galaxy Charts?
6
-
7
- Galaxy Charts is a powerful visualization plugin framework built specifically for the Galaxy platform. Designed with modern web development tools, Galaxy Charts uses the following technologies to create a flexible and dynamic environment for developing visualizations:
8
-
9
- <div class="grid grid-cols-5 gap-12 text-center my-10">
10
- <div class="flex flex-col items-center">
11
- <img src="/vite.svg" alt="vite" class="w-16 h-16">
12
- <span class="font-bold mt-2">Vite</span>
13
- </div>
14
- <div class="flex flex-col items-center">
15
- <img src="/vitest.svg" alt="vitest" class="w-16 h-16">
16
- <span class="font-bold mt-2">Vitest</span>
17
- </div>
18
- <div class="flex flex-col items-center">
19
- <img src="/vue.svg" alt="vue" class="w-16 h-16">
20
- <span class="font-bold mt-2">Vue 3</span>
21
- </div>
22
- <div class="flex flex-col items-center">
23
- <img src="/naive-ui.svg" alt="naive-ui" class="w-16 h-16">
24
- <span class="font-bold mt-2">Naive UI</span>
25
- </div>
26
- <div class="flex flex-col items-center">
27
- <img src="/tailwind.svg" alt="tailwind" class="w-16 h-16">
28
- <span class="font-bold mt-2">Tailwind CSS</span>
29
- </div>
30
- </div>
31
-
32
- With Galaxy Charts, you can develop visualizations locally in Vue, taking advantage of advanced tooling like hot-reloading for instant feedback, efficient bundling for optimized performance, and other modern features. This setup enables a streamlined and responsive development experience.
33
-
34
- <div class="flex justify-around items-center p-1">
35
- <img class="border-2 rounded border-gray-100" src="/galaxy-charts-demo.gif" alt="demo" width="80%">
36
- </div>
37
-
38
- ### Key Features
39
-
40
- - **Local and Remote Data Access**: Load data locally or connect to a remote Galaxy instance to access data providers and resources through the Galaxy API, giving you flexibility in sourcing data.
41
- - **Automated Testing**: Test your visualization thoroughly in the local environment, ensuring it’s fully functional and bug-free before deploying it to Galaxy.
42
- - **Enhanced Development Workflow**: By integrating state-of-the-art development tools, Galaxy Charts provides a smooth and efficient workflow that significantly reduces the time and effort needed to build complex visualizations.
43
-
44
- In short, Galaxy Charts transforms and simplifies the process of developing and deploying visualizations on the Galaxy platform, offering an unparalleled experience for developers working in the Galaxy ecosystem.
45
-
@@ -1,38 +0,0 @@
1
- # Vue Component
2
-
3
- The `GalaxyCharts` core component is used to embed a JavaScript-based visualization by placing the visualization code within its `#default` slot. This component parses static `config` options and the XML visualization wrapper to render both the viewport and input form.
4
-
5
- ```vue
6
- <script setup>
7
- import { GalaxyCharts } from "galaxy-charts";
8
-
9
- // Configuration of your visualization
10
- const config = {
11
- dataset_id: "MY_DATASET_ID",
12
- dataset_url: "MY_DATASET_URL",
13
- settings: {},
14
- };
15
-
16
- // XML wrapper of your visualization
17
- const xml = "MY_VISUALIZATION.xml";
18
- </script>
19
-
20
- <template>
21
- <GalaxyCharts :config="config" :xml="xml">
22
- <template #default="{ datasetId, datasetUrl, root, settings, specs, tracks }">
23
- <!-- Place your plugin code here! -->
24
- </template>
25
- </GalaxyCharts>
26
- </template>
27
- ```
28
-
29
- ## Overview of Slot Values
30
-
31
- | Variable | Description |
32
- |----------|-------------|
33
- |**datasetId**| The ID of the main dataset to be visualized. Every visualization requires a primary dataset, although additional datasets can be added later if needed.|
34
- |**datasetUrl**| The URL of the dataset to be visualized. The entire dataset may be requested for visualization, or only parts/metadata may be retrieved via the Galaxy API.|
35
- |**root**| The proxy route to the Galaxy server (default is '/').|
36
- |**settings**| Configuration settings specific to the visualization, as declared in the XML wrapper.|
37
- |**specs**| Static specification values defined in the XML wrapper.|
38
- |**tracks**| Track configuration values for the visualization, as specified in the XML wrapper.|