move_dashboard_gadget - 2024.1 English

Vivado Design Suite Tcl Command Reference Guide (UG835)

Document ID
UG835
Release Date
2024-05-30
Version
2024.1 English

Reposition the Gadget for Project summary dashboard

Syntax

move_dashboard_gadget ‑name <arg> ‑row <arg> ‑col <arg> [‑dashboard <arg>]
    [‑quiet] [‑verbose]

Usage

Name Description
-name Name of the gadget
-row Target row number to which the gadget has to be moved
-col Target column number to which the gadget has to be moved
[-dashboard] Name of the dashboard to which the gadget is associated
[-quiet] Ignore command errors
[-verbose] Suspend message limits during command execution

Categories

Project

Description

Specify the placement of a dashboard gadget into the dashboard.

Tip: Currently the Project Summary is the only dashboard, so the gadget is placed into that dashboard.

The arrangement of gadgets in a dashboard is by row and column. The Project Summary dashboard has two columns, 0 and 1, and has as many rows as needed to display all the gadgets. If you specify a column other than 0 or 1, or specify a row in excess of the current defined rows + 1, an error will be returned.

Arguments

-name <arg> - (Required) Specify the name of the gadget to move.

-row <arg> - (Required) Specify the row in the Project Summary dashboard for the gadget placement.

-col <arg> - (Required) Specify the column in the Project Summary dashboard for the gadget placement.

-quiet - (Optional) Execute the command quietly, returning no messages from the command. The command also returns TCL_OK regardless of any errors encountered during execution.
Note: Any errors encountered on the command-line, while launching the command, will be returned. Only errors occurring inside the command will be trapped.
-verbose - (Optional) Temporarily override any message limits and return all messages from this command.
Note: Message limits can be defined with the set_msg_config command.

Example

The following example moves the specified gadget to column 0, row 3:

move_dashboard_gadget -name utilization_1 -row 3 -col 0