The simplest 10.1.5 path to operator-authored chart annotations: one property setting, no scripts, no custom tables.

How-to GuidesSolution ExamplesFeature ExamplesUser Interactions ExamplesTrendChart Annotations Example → (10.1.5 draft) Quick start (zero-config)


Draft preview — 10.1.5

This page documents behavior introduced in version 10.1.5. It is a draft preview, soft-launched as a child of the live TrendChart Annotations Example page. Promote to the parent page when 10.1.5 GA ships.

The simplest pattern

Starting in 10.1.5, the TrendChart and DrillingChart controls support operator-authored annotations with zero scripting and zero schema work. The platform auto-creates a SQL Annotations table on first run and ships a built-in operator dialog and pin-rendering path.

Three steps:

  1. Open the chart's properties pane in Designer.
  2. Set AnnotationsSource = "Annotations".
  3. Save and run.

That's it. No Script.Class, no Dataset configuration, no custom dialog.

Runtime experience

At runtime:

  1. Operator right-clicks the chart.
  2. Picks Add Tag Note from the context menu.
  3. The platform-supplied annotation dialog opens. Operator types content; clicks OK.
  4. The annotation is INSERTed into the auto-created Annotations table.
  5. On the next chart refresh, a pin renders on the appropriate pen at the timestamp.

(Screenshot placeholder: Trend chart with three annotation pins on the temperature pen, after the operator added them via the context-menu flow.)

Leaving the override hooks empty

The TrendChart exposes four optional *Method override tags — AddNoteMethod, AddRangeEventMethod, GetAnnotationTableMethod, MouseClickAnnotationMethod. For the zero-config path, leave all four empty. The chart's built-in default takes over for both the add path (operator dialog → INSERT) and the read path (SELECT → pin rendering).

If later you need to customize the add UX or replace the read query (for example, to filter by user role or join in shift metadata), set the corresponding *Method tag to a method on a Script.Class — the chart will call that instead of the platform default for that one action only. Mix and match per-action.

Operator opt-out (kiosk / view-only deployments)

To hide annotation context-menu items wholesale on a kiosk, regulated, or view-only deployment, drive Client.TrendChart.AnnotationsEnabled = false at runtime. No scripting required — the four context-menu items disappear and read-back rendering is suppressed. Pair this with a tag binding (e.g., bind to a user-role expression) for per-session control.

Where to go next


In this section...

  • No labels