General properties

Edit online

Learn about the common and general properties that are used in configuration of a widget.

Attribute Meta information Data type Description Possible values
state.empty.link.href.type widgetOption String A URL, possibly to help text if there is no data found.
{
  "name": "state.empty.link.href.type",
  "metaInformation": "widgetOption",
  "values": ["NEW_WINDOW"]
}
 NEW_WINDOW, CUI_SHELL, LAYOUT_TEMPLATE, LAYOUT
pagination.enable tableOption Boolean Specifies whether the table widget can be paginated or not. False by default.
{
  "name": "pagination.enable",
  "metaInformation": "tableOption",
  "values": [true]
}
 true, false
pageLength tableOption Integer Specifies whether you want to increase the size of a result set.
{
  "name": "pageLength",
  "metaInformation": "tableOption",
  "values": ["10"]
}
resizeToContent widgetOption Boolean Specifies whether the widget should attempt to resize based on the content.
{
  "name": "resizeToContent",
  "metaInformation": "widgetOption",
  "values": ["true"]
}
 true, false
state.error.image widgetOption String Image to display on error. Do not change. 
{
  "name": "state.error.image",
  "metaInformation": "widgetOption",
  "values": ["systemError"]
}
 systemError
state.empty.body widgetOption String Body text to display if no data is found for the widget.
{
  "name": "state.empty.body",
  "metaInformation": "widgetOption",
  "values": ["Star a work queue to see it here."]
}
state.empty.link.label widgetOption String Text to display on a link if no data is found. Use with state.empty.link.href.path.
{
  "name": "state.empty.link.label",
  "metaInformation": "widgetOption",
  "values": ["Learn more"]
}
state.error.body widgetOption String Body text to display on error.
{
  "name": "state.error.body",
  "metaInformation": "widgetOption",
  "values": ["Try searching again."]
}
state.empty.link.href.path widgetOption String A URL, possibly to help text if no data is found.
{
  "name": "state.empty.link.href.path",
  "metaInformation": "widgetOption",
  "values": ["https:\/\/www.ibm.com\/docs\/en\/sscis?topic=troubleshooting-no-data-display"]
}
draggable widgetOption Boolean Specifies whether the widget can be moved on the screen by the end user. 
{
  "name": "draggable",
  "metaInformation": "widgetOption",
  "values": [false]
}
 true, false
state.empty.image widgetOption String Image to display if there is no data. Do not change. 
{
  "name": "state.empty.image",
  "metaInformation": "widgetOption",
  "values": ["dataEmpty"]
}
 noResults
chart.type widgetOption String If chartType is set to carbon_chart, then this value specifies the specific chart type to use.
{
  "name": "chart.type",
  "metaInformation": "widgetOption",
  "values": ["simpleBar"]
}
 simpleBar, line, pie, donut, meterChart
state.empty.title widgetOption String Title text to display if no data is found for the widget.
{
  "name": "state.empty.title",
  "metaInformation": "widgetOption",
  "values": ["You don't have any starred work queues yet"]
}
state.error.title widgetOption String Title text to display on error.
{
  "name": "state.error.title",
  "metaInformation": "widgetOption",
  "values": ["Uh oh. Something's not right."]
}
Total attributes: 14