Widget Development Kit

• Type: string
• Description: The name field is a unique identifier for the widget. Here are the rules.
  • name field must be unique
  • name field cannot start with a dot or an underscore
  • uppercase letters are not allowed
  • the name ends up being part of a URL, an argument on the command line, and a folder name. Name cannot contain any non-URL-safe characters.

Example: widget.json, field 'name'

{
  "name": "my-widget"
}

• Type: string
• Description: This contains the widget's version and it must be parseable by node-semver. Changes to the widget come along with the changes to the version when published.

Example: widget.json, field 'version'

{
  "version": "3.5.0"
}

• Type: string
• Description: the title is a user-friendly display name for the widget.

Example: widget.json, field 'title'

{
  "title": "My Widget"
}

• Type: string
• Description: runtime represents which version of WDK is being used to develop against. This field is automatically generated and you will not need to modify this field.

Example: widget.json, field 'runtime'

{
  "runtime": "3.0.0"
}

• Type: string
• Description: The description field contains the description of the widget. It helps user to discover the widget.

Example: widget.json, field 'description'

{
  "description": "Historical temperature data for a city."
}

• Type: Array<string>
• Description: tags is a set of keywords to describe the widget. It is useful for widget discovery.

Example: widget.json, field 'tags'

{
  "tags": [ "weather", "location", "time series" ]
}

{
  [mimeType: string]: Array<ExportTypeConfigType>
}

type ExportTypeConfigType = {
  value: string,
  label: string
};

• Description: An object which maps from MIME type keys to an array of export types for each MIME type. This field was introduced in SevOne Data Insight 3.12 or insight-widget-runtime 1.3.0-beta.12. To support older versions, you do not need to also pass exportMimeTypes . However, please refer to the note about including a fallback in the widget's exportData function.

Example: widget.json, field 'exportTypes'

{
  "exportTypes": {
    "text/csv": [
      {
        "value": "AS_VISUALIZED",
        "label": "As Visualized"
      },
      {
        "value": "TIME_SERIES",
        "label": "Time Series"
      },
      {
        "value": "SUMMARY",
        "label": "Summary"
      }
    ],
    "application/json": [
      {
        "value": "AS_VISUALIZED",
        "label": "As Visualized"
      },
      {
        "value": "RAW_DATA",
        "label": "Raw Data"
      }
    ]
  }
}

For simpler use-cases where only one export type is needed for each MIME type, you may use field exportMimeTypes.

• Type: Array<string>
• Description: This is a set of MIME types representing the formats the widget can export data as.

Example: widget.json, field 'exportMimeTypes'

{
  "exportMimeTypes": [ "text/csv", "application/json" ]
}

• Type: Array<FacetSchema>
• Description: This is a set of facet schemas the widget may broadcast.

Example: widget.json, field 'producedFacets'

{
  "producedFacets": [
    {
      "$id": "my-location",
      "type": "object",
      "properties": {
        "city": {
          "type": "string"
        },
        "state": {
          "type": "string"
        }
      },
      "required": [ "city", "state" ]
    }
  ]
}

• Type: Array<FacetSchema>
• Description: This is a set of facet schemas the widget is capable of handling and processing internally into the configuration.

Example: widget.json, field 'consumedFacets'

{
  "consumedFacets": [
    {
      "$id": "my-location",
      "type": "object",
      "properties": {
        "city": {
          "type": "string"
        },
        "state": {
          "type": "string"
        }
      },
      "required": [ "city", "state" ]
    }
  ]
}

type ExportTypeConfigType = {
  value: string,
  label: string
};

(
  configuration: Config,
  data: Data,
  mimeType: string,
  exportTypeConfig?: ExportTypeConfigType
) => Blob | Promise null

{
  "$id": "my-timespan",
  "type": "object",
  "properties": {
    "startTime": {
      "type": "number",
      "description": "Start time."
    },
    "endTime": {
      "type": "number",
      "description": "End time."
    },
    "timezone": {
      "type": "string"
    }
  },
  "required": [ "startTime", "endTime" ]
}