Skip to content

Allow embedding vitessce visualizations #19909

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged

Conversation

mvdbeek
Copy link
Member

@mvdbeek mvdbeek commented Mar 26, 2025

Seems to work fine AFAICT. It's not super useful without expanding to full width/height.

Screenshot 2025-03-26 at 13 02 31

How to test the changes?

(Select all options that apply)

  • I've included appropriate automated tests.
  • This is a refactoring of components with existing test coverage.
  • Instructions for manual testing are as follows:
    1. [add testing steps and prerequisites here if you didn't write automated tests covering all your changes]

License

  • I agree to license these and all my past contributions to the core galaxy codebase under the MIT license.

Seems to work fine AFAICT. It's not super useful without expandable
report sections though.
Copy link
Contributor

@guerler guerler left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for looking into this. We do have a Vitessce cell-type in the markdown editor. Having a specific cell will allow us to change the datasets using a dialog and seamlessly integrate workflow labels from reports. However, there is at least one benefit to also adding it as individual visualization as you suggest here: it would allow users to select vitessce-files from the history to be displayed in pages. There is no overhead to enabling this.

vitessce

@guerler guerler merged commit 6786a84 into galaxyproject:dev Mar 26, 2025
52 of 54 checks passed
@github-project-automation github-project-automation bot moved this from In Progress to Done in GBCC2025 Live Planning Board Mar 26, 2025
Copy link

This PR was merged without a "kind/" label, please correct.

@nsoranzo nsoranzo deleted the all_embedding_vitessce_visualizations branch March 26, 2025 16:35
@mvdbeek
Copy link
Member Author

mvdbeek commented Mar 26, 2025

I want that, but I don't see how I can align the gif with what you're writing. With this change I can embed a json file produced by a workflow. If there's a better way to do that please let us know. Also please don't call this thing Hello World, everyone's gonna scroll right past that.

@guerler
Copy link
Contributor

guerler commented Mar 30, 2025

@mvdbeek Yeah, we should probably call it VitessceTemplate or something similar. And yes, there's a better way to handle this. In the GIF, you can see a Vitessce-specific cell type—the Vitessce JSON exists only within the Markdown and isn’t tied to a JSON file in the history. This is a useful to dynamically map workflow outputs to Vitessce inputs. I'm working on a PR to support this functionality. So unless you already have a tool that generates the Vitessce JSON as part of your workflow—which would also be a valid approach—it probably makes sense to wait for this update. Once it's in, you’ll be able to use workflow labels to assign Vitessce inputs directly.

@mvdbeek
Copy link
Member Author

mvdbeek commented Mar 30, 2025

Are you suggesting that the user builds the dashboard config in the report ? Curious to see how that'll work, I worry a little that that is going to be way too difficult to write (especially without an associated schema), but it does mean the dashboard creation tool doesn't need to hook into app to build dataset urls.

@guerler
Copy link
Contributor

guerler commented Mar 30, 2025

@mvdbeek Yes, there's no need for a dashboard creation tool. Users can paste the associated schema directly into the editor cell, as shown above. Once pasted, they will be able to use the Attach Data button (implementation currently in progress) in the Guide bar to map datasets or workflow labels to the available Vitessce input files in the schema—similar to how the current editor allows attaching data to Galaxy components and Visualizations.

@guerler
Copy link
Contributor

guerler commented Mar 30, 2025

Let's go step-by-step tho, let's first complete #19923.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

2 participants