Migrate Custom Charts
Custom charts in Composer can be created and managed using the Composer Custom Chart CLI tool.
- Composer Custom Chart CLI version 1 (
composer-chart-cli) supports Composer 7.10 and later.
- CLI version 6 (
zoomdata-chart-cli) supports Composer 7.10 and earlier.
- CLI version 5 (
zoomdata-chart-cli) supports Composer 7.9 and earlier.
Install Composer Custom Chart CLI version 1 globally. Existing custom charts from older CLI versions (5 and 6) use the same directory structure as the Composer Custom Chart CLI version 1 directory structure.
The following table lists the version of the CLI compatible with different versions of Composer.
|CLI Version||Supported Versions|
|1||Composer 7.10 and later. (|
|6||Composer 7.9 and later. (|
|5||Composer 6.9 and through Composer 7.8 and earlier. (|
Composer v7.10 and later works with the new version of the Composer CLI tool, version 1 (
composer-chart-cli). This new version of the CLI tool enables you to manage custom charts in your Composer v7.10 and later environment. Familiar commands and locations have changed: commands that use
zd now use
cmp, and that use
zoomdata now use
The custom chart file structure for supported versions of custom charts:
- Composer Custom Chart CLI v1 (
- CLI v6 (
- CLI v5 (
Custom Chart CLI File Structure
Composer Custom Chart CLI version 1 only supports the use of
vnd.composer.v3+json as the
Content-Type for API routes.
The command differences between CLI versions are described in the following table:
|Command v1||Command v5/v6||Description|
|Import a visual in a zip file.|
|Create a new visual in a folder you specify.|
|Update the visual locally, but no longer push the updated visual to the server.|
|Push a custom chart to the server.|
|Watch changes in the |
If you need to migrate custom charts from an unsupported version of Composer, contact Technical Support for assistance.