Magidoc

createDashboardWidget
Mutation

Creates a new dashboard widget with specified configuration. Common configurations by widget type:

  1. Chart Widgets (Bar/Line/Pie):
  • Set chartType, XAxis, YAxis
  • Configure grouping and aggregation
  • Set up color schemes
  1. List Widgets (Actions/Projects):
  • Define filters (status, assignee, etc.)
  • Set up sorting and grouping
  • Configure display options
  1. Status Widgets:
  • Specify project or goal
  • Configure metrics to display
  • Set up refresh intervals
  1. Custom Widgets:
  • Set up embedded content
  • Configure interactive elements
  • Define data sources

Arguments

#

dashboardId

containerId

containerType

Type of container this widget belongs

type

Non-null

The type of dashboard widget to create

title

Non-null

Title text to display for the widget

titleColor

Hex color code for the widget title

titleSize

Size of the title text

fileIds

[ ID !]

Array of file IDs associated with this widget

chartType

Type of chart to display

sort

Sort order for widget data

url

URL for embedded content widgets

projectId

ID of associated project

goalId

ID of associated goal

noteId

ID of associated note

showTitles

Whether to show titles in the widget

showLegend

Whether to show chart legend

ignoreContainerFilter

If true, widget ignores container-level filters

legendPosition

Position of the chart legend

showValueLabels

Whether to show data point values

showRowTotals

Whether to show row totals

showColumnTotals

Whether to show column totals

showLinkedToProject

Whether to show links to related projects

truncateLongNumbers

Whether to truncate long numbers

displayGroupsAs

How to display grouped data

timeUnitsType

Time unit for temporal data

projectTreeLevelsToShow

[ Int !]

Which levels of project tree to display

isProjectTreeLevelActive

Whether project tree level is active

reportOn

What type of data to report on

XAxis

Field to use for X-axis

XAxisCustomFieldId

Custom field ID for X-axis

XAxisTitle

Title for X-axis

YAxis

Field to use for Y-axis

YAxisCustomFieldId

Custom field ID for Y-axis

YAxisTitle

Title for Y-axis

YAxisGroupBy

Field to group Y-axis values by

groupByCustomFieldId

Custom field ID for grouping

chartValueColors

Color configuration for chart values

sectionHeaderText

Text for section header

sectionHeaderTextAlignment

Alignment of section header text

sectionHeaderLinePosition

Position of section header line

isHidden

Whether widget is hidden

projectDetailsFields

[ String !]

Fields to show in project details

contentTextAlignment

Alignment of content text

contentTextSize

Size of content text

contentTextColorPrimary

Primary color for content text

contentTextColorSecondary

Secondary color for content text

workspaceId

ID of workspace this widget belongs to

Response

#

Returns DashboardWidget !.

Example

#

    
  

3

    
  

3

    
  

3