Skip to main content

Configure a Column Header Tooltip

  1. Open your RISKSHEET configuration file (risksheet.json)
  2. Locate the column definition where you want to add a tooltip
  3. Add the headerTooltip property with your description:
{
  "id": "severity",
  "header": "Severity",
  "type": "enum:SeverityRating",
  "headerTooltip": "Rate the potential impact of the failure on the customer or system"
}
  1. Save the configuration file
  2. Refresh the RISKSHEET widget

Configure a Group Header Tooltip

For column groups, use the headerGroupTooltip property. This property must be placed in the first column of the group to work correctly.
{
  "id": "causes",
  "header": "Potential Causes",
  "headerGroup": "Risk Analysis",
  "headerGroupTooltip": "Identify root causes that could lead to the failure mode",
  "type": "text"
}
The headerGroupTooltip property only works when added to the first column in the group. If you place it on a different column in the group, the tooltip will not appear.

Tooltip Configuration Patterns

Here’s how tooltips work at different header levels: diagram
  • ℹ️ Explain rating scales (“1 = Low, 10 = High”)
  • 📖 Define industry-specific terminology
  • Clarify what data should be entered
  • Reference related documentation or standards
  • • List enumeration options without opening the dropdown

Example: Risk Assessment Columns

Here’s a complete example showing tooltips for typical FMEA columns:
"columns": [
  {
    "id": "failureMode",
    "header": "Failure Mode",
    "headerTooltip": "Describe how the item could fail to meet design intent",
    "type": "text"
  },
  {
    "id": "sev",
    "header": "S",
    "headerGroup": "Initial Risk",
    "headerTooltip": "Severity: 1=Minor inconvenience, 10=Safety hazard",
    "headerGroupTooltip": "Risk ratings before mitigation actions",
    "type": "enum:SeverityRating"
  },
  {
    "id": "occ",
    "header": "O",
    "headerGroup": "Initial Risk",
    "headerTooltip": "Occurrence: 1=Rare, 10=Almost certain",
    "type": "enum:OccurrenceRating"
  },
  {
    "id": "det",
    "header": "D",
    "headerGroup": "Initial Risk",
    "headerTooltip": "Detection: 1=Certain to detect, 10=Cannot detect",
    "type": "enum:DetectionRating"
  }
]

Verification

You should now see:
  • A tooltip appearing when you hover over any configured column header
  • The tooltip text matching your headerTooltip configuration
  • For grouped columns, a separate tooltip on the group header row
Header tooltips are just one of many configuration properties available. For a comprehensive list of all configuration options, see the Configuration Properties Index.

See Also

KB ArticlesSupport TicketsSource Code
  • AppConfig.ts
  • risksheet.json
  • MultiItemLinkEditor.ts
  • ComparisonManager.ts
  • AppConfigHelper.ts