Skip to content

XML Wrapper

Galaxy Visualizations are configured using XML files. The files contain Visualization specific attributes such as the name, description and the associated npm package details.

xml
<visualization name="MY_VISUALIZATION">
    <description>MY_DESCRIPTION</description>
    <requirements>
        <requirement type="npm" version="MY_NPM_PACKAGE_VERSION" package="MY_NPM_PACKAGE_NAME"/>
    </requirements>
    <entry_point entry_point_type="script" src="dist/index.js" css="dist/index.css" />
    ...
</visualization>

This XML template includes the following variables:

VariableDescription
MY_VISUALIZATIONSpecifies the name of the visualization.
MY_DESCRIPTIONProvides a brief description of the visualization, including references if it’s a third-party plugin.
MY_NPM_PACKAGE_NAMEIndicates the npm package name. Update this field with the correct package name before publishing.
MY_NPM_PACKAGE_VERSIONSpecifies the version number of the npm package upon publishing.