Sway Charts Pro Scripts Documentation
  • Sway Charts Pro User-Defined Indicators
    • Introduction
      • 1.1 Access to the Sway Charts scripting framework (UDI vs UDIX)
      • 1.2 Example UDI code
      • 1.3 Adding a UDI to a chart
      • 1.4 Lifecycle
      • 1.5 Alerts
      • 1.6 Indicator-on-indicator
      • 1.7 Technical note: web workers
      • 1.8 Technical note: dates
    • Initialisation: UDI.onInit()
      • 2.1 Return value from UDI.onInit()
      • 2.2 The plots[] array
      • 2.3 The settingsFields[] array
      • 2.4 Context data passed to UDI.onInit()
    • Calculating data: UDI.onCalculate()
      • 3.1 Reading settings fields
      • 3.2 Input data for the UDI
      • 3.3 Updates of the current bar only
      • 3.4 Calculating output data
      • 3.5 Requesting out-of-band updates
      • 3.6 Technical analysis: moving averages, ATR etc
    • Changes to the chart or parameters
      • 4.1 UDI.onContextChange()
      • 4.2 UDI.onParameterChange()
    • Creating drawings, event markers, and bar highlights
      • 5.1 Creating drawings
      • 5.1.1 Drawing properties
      • 5.2 Creating event markers
      • 5.2.1 Click notifications from event markers
      • 5.3 Creating bar highlights
    • Notifying the user
      • 6.1 Creating toast
      • 6.2 Changing the panel background colour
    • Adding HTML to the chart
      • 7.1 Adding HTML
      • 7.2 Positioning the HTML
      • 7.3 Sending messages from the HTML to the UDI
      • 7.4 Sending messages from the UDI to the HTML
    • Recommended trade
      • 8.0 Recommended trade
    • Other indicator topics
      • 9.1 Collecting external data
      • 9.2 Converting dates to chart time
      • 9.3 Multi-timeframe (MTF) indicators
  • Sway Charts Pro Framework
    • Examples
    • Collections, objects, and properties in the framework
    • Functions in the framework
    • Messages and event handlers
    • Working with candle data
    • Widget HTML and CSS reference
    • Sway.utils and other helper functions
    • Framework error codes
    • Script contexts
    • Sending mail into Sway Charts Pro from outside the platform
    • language variables
Powered by GitBook
On this page
  1. Sway Charts Pro User-Defined Indicators
  2. Creating drawings, event markers, and bar highlights

5.3 Creating bar highlights

Bar highlights change the colours of specific bars on the chart, in order to highlight them in some way.

The definition of a bar highlight simply has two properties:

Property

Description

date

Date for the highlight, as a number of milliseconds. Does not have to match the start time of a bar. Will change the bar which contains the specified time.

color

Color for the bar, as an HTML colour code such as "red" or "#FF0000" or "rgba(255,0,0,0.5)"

You create bar highlights by passing an individual definition, or an array of definitions, to UDI.createBarHighlight (). If you are creating several highlights at once, it is far more efficient to pass an array than to make multiple calls to UDI.createBarHighlight (). For example:

UDI.createBarHighlight([
	{date: data.barData.date[i - 1], color: "red"},
	{date: data.barData.date[i - 2], color: "green"}
]);

Individual highlights can be removed by passing a date, or an array of dates, to UDI.removeBarHighlight(). For example:

UDI.removeBarHighlight([data.barData.date[i - 1], data.barData.date[i - 2]]);
Previous5.2.1 Click notifications from event markersNextNotifying the user

Last updated 1 year ago