Configuration

---

Widget

A top level configuration defining a 3DDASHBOARD widget app that could be added to the compass.

Overview	Structure

Widget properties

Prop Name	Description	Data Type	Required	Example
columns	Table column definitions. Columns	object	no	"columns": { "title": { "label": "Title", "data": "title" } }
commands	Command definitions. Commands	object	no	"commands": { "csvExport" : { "type": "export", "label": "CSV Export", "settings": { "columns": [ "title", "description" ], "excludeHiddenColumn": true } } }
defaultServiceParams	This is used for support caching. Services	object	no	"defaultServiceParams": { "enableCache": false, "cacheTimelimit": 1 }
description	Visible in admin UI widget list	string	no
datasets	Dataset definitions. Used to load data rom the graph into components (e.g. to a table) Data sets	object	no	"datasets": { "ups-roots-example": { "type": "expand", "edgeStatement": "[type='VPMInstance']", "nodeStatement": "[type='VPMReference']" } }
extends	Inherits from other configs to reuse common definitions.	array string	no	"extends" : ["dsapi-dseng.json", "presets.json"]
fields	Form field definitions Fields	object	no	"fields": { "title" : { "label": "Title", "data": "title", "type": "text" } }
forms	Form definitions Forms	object	no
layouts
resources	Load additional resources for additional functionality.	array string	no	["plugin.js", "excelReport.js"]
requiresContext	Contextual widgets requires an object to be dropped and initially renders a drop zone.	boolean	no
root	The main component (e.g. a layout, table, form)	string	yes
services	Service definitions used to retrieve data Services	object	no	"services": { "changeAction" : { "uri": "/resources/v1/modeler/dslc/changeaction/{{contextId}}", "transformer": { "name": "corpusgeneric", "inputs": { "identifier": ["id"] } } } }
tables	Table definitions Tables	object	no	"tables": { "myTable" : { "datasets": [ "contextNode" ], "columns": [ "title", "state" ] } }
tabs
title	Widget name displayed in the UI	string	yes
toolbars	Toolbar definitions Toolbars	object	no

{
    "$schema": "https://widgets.technia.cloud/schema.json",
    "title": "",
    "description" : ""
    "root" : "",
    "requiresContext": true,
    "resources": [],
    "extends": [],
    "tables" : {},
    "forms" : {},
    "layouts" : {},
    "tabs" : {},
    "charts" : {},
    "columns": {},
    "fields": {},
    "datasets": {},
    "toolbars": {},
    "commands": {},
    "services": {}
}