All Products
Search
Document Center

DataV:instructions-of-desktop-developer-tool

Last Updated:Nov 06, 2025

This topic describes how to use desktop development tools, including download and installation, logon, workspace management, and component management, to help you quickly use desktop development tools to develop components and publish them.

Download and install desktop development tools

  1. Log on to the DataV console.

  2. In the Component Development section, click Component Package.

  3. Click Download Developer Tools.

    image

  4. In the Select Version to Download dialog box, select a version and click Download. image

    The system provides three versions of tools for you to choose from: MAC, WIN, and Terminal:

    • MAC: for macOS operating system.

    • WIN: for Windows operating system.

    • Terminal: This method is applicable to the Linux operating system. After you click Download, you will be redirected to the Quick Start for Component Development section of the Developer Guide. For more information, see Install the development tool kit.

  5. (MAC and WIN versions) After the download is complete, double-click the application to install it.

Log on to the desktop development tool

  1. After the installation is complete, double-click to open the tool, fill in the login information to log in, or choose not to log in offline development.

    开发者工具登入界面

    Important

    The publish feature cannot be used for offline development. Use it with caution.

    Parameter

    Description

    Username

    The Alibaba Cloud account that is used to log on to DataV.

    Token

    The identifier of the developer. On the My Widgets tab of the DataV console, click My Widgets, copy the Developer ID, and paste it to the input box.

  2. After the logon is successful, click Switch User to return to the logon page.

    开发者工具切换用户界面

Create Workspace

  1. On the Developer Tools page, click + Create Workspace in the lower-right corner.

  2. Select a local folder as the package management folder.

  3. Click Select Folder to create a workspace.

    新建工作区

    Note
    • A workspace is just a folder that contains many components. It can have the same name as an online component package, or it can have the same name.

    • If a folder that contains components already exists, you can open the folder. The tool automatically identifies the DataV components in the folder.

Workspace overview

After the workspace is created, it is displayed on the right side of the page. Click the workspace name to go to the Workspaces page. The Workspace page contains the following four sections: 工作区页面样式

No.

Component

Description

1

Sidebar

Contains functions such as hiding the component bar, viewing help documents, and logging out.

2

Component Bar

Displays the widget list and manages the widget.

  • Displays a list of components.

  • You can copy components, rename components, delete components, view component details, and refresh workspaces.

3

Canvas

  • The canvas displays the widget and all changes to the widget in real time.

  • Widget settings and data changes on the right-side panel are shown on the canvas.

  • You can drag and drop the borders to resize the widget.

4

Component configuration bar

The following four panels are available: Configuration, Data, Interaction, and Publish.

  • Configuration: The configuration page contains some configuration items that can be changed. When you perform configuration operations, the changes take effect immediately. For example, if you drag the Font Size slider on the widget, the font size of the widget changes immediately. Click Save in the upper-right corner to save the modified configuration and use the current configuration as the default configuration of the widget.

  • Data: The data page contains the data interface configuration of the widget. If the data on the data page is changed, the widget will be changed accordingly. Click Save in the upper-right corner to save the modified data and use the current data as the default data of the widget.

  • Interaction: The Interaction page contains the interaction description of the widget.

  • Publish: On the Publish page, you can configure the basic properties, type, icon, and version of the component. Click Publish in the upper-right corner to publish the component.

Delete a workspace

In the workspace list, move the pointer over a workspace and click the X in the upper-right corner to delete the workspace. 删除工作区

Create a component

  1. Click + Create Component on the right side of the workspace page, or use the Ctrl + N shortcut key to create a component.

    After the widget is created, the basic text widget appears on the Create Widget page.

  2. Click the Basic Text component and configure the component as described in the following table.

    配置新建组件样式

    Parameter

    Description

    Component Name

    Enter a name for the component.

    Component Type

    Select a widget type from the drop-down list.

    Publish ID

    Select an available widget package from the drop-down list. If no widget package is available, click Custom to go to the DataV console and create a widget package. For more information, see Manage widget packages.

    Component ID

    Enter the component ID, for example, basic-text.

  3. Click Create to create the widget.

    After the widget is created, you can view the widget in the center canvas and configure the widget in the right-side configuration pane. 查看已创建的组件界面

    After the component is created, the index.js and package.json files are generated in the local component package folder. You can customize the configuration items of the component by editing these two files by referring to Component Development Package File Overview. 自定义组件配置项

Preview a widget

After you create a widget, you can click a widget in the widget list on the left side of the page to view the style of the widget in the center canvas area.

Copy /Delete /Rename /View Component Details

Right-click a component and choose Make Copy, Delete, Rename, or Show Properties to copy, delete, rename, or view the details of the component.

You can also select a component and click the Copy Component or Delete Component icon in the lower part of the component bar to copy or delete the component. 复制删除组件入口

Refresh Workspace

Click the Refresh Workspace icon (刷新工作区图标) to refresh the workspace. After you modify the configuration items of a component, you can use this feature to display the latest component configuration items.