modifyWidget

Back to index

Summary

Modifies a widget.

projectName

Stringrequired

The name for the project that must be unique among all projects.

dashboardName

Stringrequired

Unique name of the dashboard within the project.

widgetName

Stringrequired

The name of the dashboard widget.

actualParameters

Mapoptional

Actual parameter values for the parameters defined on the widget's report.

afterWidget

Stringoptional

The name of the widget after which this widget should be placed.

attributeDataTypes

Mapoptional

Widget parameters used by UI to control data types of attributes.

attributePaths

Mapoptional

Widget parameters used by UI to control paths of attributes.

beforeWidget

Stringoptional

The name of the widget before which this widget should be placed.

clearAttributeDataTypes

Booleanoptional

Whether or not to clear attribute data types for the widget.

clearAttributePaths

Booleanoptional

Whether or not to clear attribute paths for the widget.

clearColors

Booleanoptional

Whether or not to clear color for the widget.

clearLinkParameters

Booleanoptional

Whether or not to clear link parameters for the widget.

clearVisualizationProperties

Booleanoptional

Whether or not to clear visualization properties for the widget.

colorRanges

Stringoptional

The JSON with color ranges definition for the widget.

colors

Mapoptional

Color map used when rendering the widget. The usage of the color map depends on the widget's visualization type.

column

Stringoptional

The column in a COMMAND_CENTER dashboard that the widget belongs to. Required for a COMMAND_CENTER dashboard widget unless the widget section is SUMMARY in which case it is not applicable.

description

Stringoptional

Comment text describing this object that is not interpreted at all by CloudBees CD/RO.

iconUrl

Stringoptional

The icon to display for the widget. Enclose the IPV6 address in square brackets. Example: [<IPv6-ADDRESS>].

linkParameters

Mapoptional

Widget parameters used by UI to construct the drill-down link for the widget.

linkTarget

Stringoptional

Determines the page to navigate to when the user drills down through the dashboard widget.

newName

Stringoptional

The new name for an existing object that is being renamed.

orderIndex

Integeroptional

Specifies the relative display order for the widget.

reportName

Stringoptional

Name of an existing report backing the widget.

reportProjectName

Stringoptional

Set if the report is in a different project than the dashboard.

section

Stringoptional

The section of a COMMAND_CENTER dashboard to display the widget in. Applicable for a COMMAND_CENTER dashboard widget.

Possible values: "PHASE_DETAIL", "PHASE_SUMMARY", "SUMMARY"

title

Stringoptional

The title to display for the widget. If not set, use the report title.

visualization

Stringoptional

Type of visualization data in the widget.

Possible values: "AREA_CHART", "CUSTOM_CHART", "DONUT_CHART", "GROUPED_HORIZONTAL_BAR_CHART", "GROUPED_VERTICAL_BAR_CHART", "HORIZONTAL_BAR_CHART", "LINE_CHART", "METRIC", "MULTILINE_CHART", "STACKED_AREA_CHART", "STACKED_HORIZONTAL_BAR_CHART", "STACKED_VERTICAL_BAR_CHART", "TABLE", "VERTICAL_BAR_CHART"

visualizationProperties

Mapoptional

Properties or settings used by the widget's visualization type.

Usage

Perl

$cmdr->modifyWidget(
  "test-projectName", # projectName
  "test-dashboardName", # dashboardName
  "test-widgetName" # widgetName
  # optionals
);▼

ectool

ectool modifyWidget \
  "test-projectName" `# projectName` \
  "test-dashboardName" `# dashboardName` \
  "test-widgetName" `# widgetName` \
  # optionals▼

Examples

Perl

$cmdr->modifyWidget("Default", "Weekly Overview", "Pipeline Runs" {title => "Pipeline Runs"}▼

ectool

ectool modifyWidget Default "Weekly Overview" "Pipeline Runs" --title "Pipeline Runs"▼