note

Places a floating text note on the chart without tying it to a specific price bar. Great for titles, checklist items, or reminders that you want to keep visible in a general area. You can add background, border, word wrap, and font styling so it’s easy to read.

Syntax (one line)

note(x, y, styles?, text?)

Parameters

x (number) · Horizontal position (screen or chart coordinate depending on implementation). y (number) · Vertical position for the note. styles (TextLineToolOverrides) · Visual and layout options for the note:

  • backgroundColor (RGBAColor | BaseColors) · Color behind the text box.

  • backgroundTransparency (number) · 0–100 background opacity (higher = lighter).

  • bold (boolean) · Make the note text bold.

  • borderColor (RGBAColor | BaseColors) · Border color around the note box.

  • color (RGBAColor | BaseColors) · Text color.

  • drawBorder (boolean) · Show a border around the note box.

  • fillBackground (boolean) · Fill the note background area.

  • fixedSize (boolean) · Keep a fixed on-screen size when zooming.

  • fontsize (number) · Font size for the text.

  • italic (boolean) · Make the note text italic.

  • wordWrap (boolean) · Wrap text onto multiple lines.

  • wordWrapWidth (number) · Pixel width used for wrapping when wordWrap is true. text (string) · The message to display inside the note.

Return Value

(string) · The drawing ID of the created Note.

Example

What this does: Every 46 candles, it places a “checklist” note at a fixed chart position. We use a soft background, a thin border, and word wrap. All visuals live in one const style.

Tips

  • Use fixedSize: true for “sticky” notes that stay readable at any zoom.

  • Enable wordWrap with a sensible wordWrapWidth so longer notes don’t overflow.

  • Choose high-contrast color vs backgroundColor for readability.

Warning

  • Very large notes or long paragraphs can clutter the chart — keep messages short and focused.

Good Practice

  • Keep a few presets (e.g., blue for info, orange for warnings, green for “done”) so notes are instantly recognizable.

  • Centralize your preferred note styling in a single const style and reuse it across scripts.

Last updated