Skip to main content

SegmentBox

One segment of a series' tree, as a partner receives it: its place in the tree and its four vertices (open, high, low, close, each with its time). Draw it as a box from open_time to close_time between low and high, with its line from open through high and low (in time order) to close. Nothing else of the tree leaves Patternode.

idstringrequired

h@<open_time>. The same segment has the same id in a segmentation and in every extension that names it, so a store keyed on it updates in place.

Possible values: Value must match regular expression ^h[0-9]+@[0-9]+$

parentstring | nullnullablerequired

The id of the segment one level up that contains this one; null at the top.

heightintegerrequired

The level: 1 is the finest segments above the bars, larger is coarser.

Possible values: >= 1

orderintegerrequired

Position among its siblings, in time order.

Possible values: >= 0

barsintegerrequired

How many bars it covers.

Possible values: >= 1

open_time objectrequired
oneOf
integer

Possible values: >= 0

opennumberrequired
high_time objectrequired
oneOf
integer

Possible values: >= 0

highnumberrequired
low_time objectrequired
oneOf
integer

Possible values: >= 0

lownumberrequired
close_time objectrequired
oneOf
integer

Possible values: >= 0

closenumberrequired
provisionalbooleanrequired

True for the open right edge: it may still grow, and its close may move. Every other segment is final.

SegmentBox
{
  "id": "string",
  "parent": "string",
  "height": 0,
  "order": 0,
  "bars": 0,
  "open_time": 0,
  "open": 0,
  "high_time": 0,
  "high": 0,
  "low_time": 0,
  "low": 0,
  "close_time": 0,
  "close": 0,
  "provisional": true
}