General

Into this page you can configure the main information of your component.

In the left part of the page you can define:

  • Name: the name of the widget that is visible into the console, for instance in the template visual editor.
    The name is different from the component ID, which is defined when the component is created and cannot be changed.

  • Description: the text visible in the Console; it provides a brief description of the purpose of the component.

  • Category: the free name used to group similar components in the console.

Widget

This section is visible only for components of type WIDGET or CONTROL.

  • Context: the context of the page the component can be placed.
    For instance, some widgets require the presence of a thing, so they can be placed only into thing-definition templates.
    The default context is THING.  

  • Tag Name: the name of the HTML tag associated to this component.
    It is recommended to use a tag name composed by only lower alphanumeric characters and minus (e.g.  machine-status-widget).

  • Class Name: the name of the JavaScript class implementing the widget (e.g. MachineStatusWidget).

  • Metric Context: identifies the metrics it is possible to select into a METRIC based widget properties (e.g. THING or LOCATION).
    The default metric context is THING.

  • Property Context:  identifies the properties it is possible to select into a PROPERTY based widget properties (e.g. THING or CUSTOMER).

Advanced Settings

  • Deprecated: is selected the component is highlighted as deprecated in the console, and you can also specify a deprecation message (e.g. Use the new status diagramā€¦).

  • Documentation URL: and URL pointing to the widget documentation, if present.