entities reference

Drawings are anchored to time and price. Each kind lives in a pool addressed by key: setting the same key again updates the drawing instead of adding one.

Functions

entities.arrowPool

entities.arrowPool(max: int, on: Surface? = null, anchor: Anchor? = null) -> ArrowPool

Creates a pool of arrows with a fixed limit.

Declare the pool with setup or state, then use it from any handler. Each drawing is identified by its keys.

• max limits the number of arrows. Values outside the entity-pool limit are rejected before the script runs. Creating a new drawing when full removes the oldest one.
• on chooses the panel or pane for every drawing in the pool. Null uses the main price pane.
• anchor chooses how to position drawings. Null uses chart coordinates.

Anchors

A pane anchor, such as anchor.topLeft or anchor.center, measures both coordinates in logical pixels from that point. An edge anchor, such as anchor.top or anchor.left, measures one coordinate inward from the edge in pixels and keeps the other in chart coordinates.

Returns ArrowPool

Available in Setup only: declarations, setup and state initialisers.

entities.boxPool

entities.boxPool(max: int, on: Surface? = null, anchor: Anchor? = null) -> BoxPool

Creates a pool of boxes with a fixed limit.

Declare the pool with setup or state, then use it from any handler. Each drawing is identified by its keys.

• max limits the number of boxes. Values outside the entity-pool limit are rejected before the script runs. Creating a new drawing when full removes the oldest one.
• on chooses the panel or pane for every drawing in the pool. Null uses the main price pane.
• anchor chooses how to position drawings. Null uses chart coordinates.

Anchors

A pane anchor, such as anchor.topLeft or anchor.center, measures both coordinates in logical pixels from that point. An edge anchor, such as anchor.top or anchor.left, measures one coordinate inward from the edge in pixels and keeps the other in chart coordinates.

Returns BoxPool

Available in Setup only: declarations, setup and state initialisers.

entities.labelPool

entities.labelPool(max: int, on: Surface? = null, anchor: Anchor? = null) -> LabelPool

Creates a pool of labels with a fixed limit.

Declare the pool with setup or state, then use it from any handler. Each drawing is identified by its keys.

• max limits the number of labels. Values outside the entity-pool limit are rejected before the script runs. Creating a new drawing when full removes the oldest one.
• on chooses the panel or pane for every drawing in the pool. Null uses the main price pane.
• anchor chooses how to position drawings. Null uses chart coordinates.

Anchors

A pane anchor, such as anchor.topLeft or anchor.center, measures both coordinates in logical pixels from that point. An edge anchor, such as anchor.top or anchor.left, measures one coordinate inward from the edge in pixels and keeps the other in chart coordinates.

Returns LabelPool

Available in Setup only: declarations, setup and state initialisers.

entities.lineFillPool

entities.lineFillPool(max: int, on: Surface? = null) -> LineFillPool

Creates a pool of line fills with a fixed limit.

Declare the pool with setup or state, then use it from any handler. Each drawing is identified by its keys.

• max limits the number of line fills. Values outside the entity-pool limit are rejected before the script runs. Creating a new drawing when full removes the oldest one.
• on chooses the panel or pane for every drawing in the pool. Null uses the main price pane.

Returns LineFillPool

Available in Setup only: declarations, setup and state initialisers.

entities.linePool

entities.linePool(max: int, on: Surface? = null, anchor: Anchor? = null) -> LinePool

Creates a pool of lines with a fixed limit.

Declare the pool with setup or state, then use it from any handler. Each drawing is identified by its keys.

• max limits the number of lines. Values outside the entity-pool limit are rejected before the script runs. Creating a new drawing when full removes the oldest one.
• on chooses the panel or pane for every drawing in the pool. Null uses the main price pane.
• anchor chooses how to position drawings. Null uses chart coordinates.

Anchors

A pane anchor, such as anchor.topLeft or anchor.center, measures both coordinates in logical pixels from that point. An edge anchor, such as anchor.top or anchor.left, measures one coordinate inward from the edge in pixels and keeps the other in chart coordinates.

Returns LinePool

Available in Setup only: declarations, setup and state initialisers.

entities.markerPool

entities.markerPool(max: int, on: Surface? = null, anchor: Anchor? = null) -> MarkerPool

Creates a pool of markers with a fixed limit.

Declare the pool with setup or state, then use it from any handler. Each drawing is identified by its keys.

• max limits the number of markers. Values outside the entity-pool limit are rejected before the script runs. Creating a new drawing when full removes the oldest one.
• on chooses the panel or pane for every drawing in the pool. Null uses the main price pane.
• anchor chooses how to position drawings. Null uses chart coordinates.

Anchors

A pane anchor, such as anchor.topLeft or anchor.center, measures both coordinates in logical pixels from that point. An edge anchor, such as anchor.top or anchor.left, measures one coordinate inward from the edge in pixels and keeps the other in chart coordinates.

Returns MarkerPool

Available in Setup only: declarations, setup and state initialisers.

Methods

entities.arrow.set

entities.arrow.set(x1: time|int|float, y1: float, x2: time|int|float, y2: float, width: float = 0, color: color? = null, style: LineStyle? = null, extend: Extend? = null, headLengthPx: float = 0, headWidthRatio: float = 0, zIndex: int = 0) -> void

Draws or updates an arrow.

x1, y1, x2, and y2 set the endpoints.

• width accepts 0.0 to 20.0, defaulting to 0.0.
• color and style use chart defaults when null.
• extend continues the arrow along its slope toward a pane edge. Use extend.left, extend.right, or extend.both; null leaves it unextended.
• headLengthPx accepts 0.0 to 200.0 pixels, defaulting to 0.0.
• headWidthRatio accepts 0.0 to 20.0, defaulting to 0.0.
• zIndex sets the drawing order and defaults to 0.

A width, head length, or head width ratio outside its range stops the script with an error.

Coordinates

The pool’s anchor determines how coordinates are measured:

• No anchor: use chart coordinates; x can be a time value.
• A pane anchor, such as anchor.topLeft: use finite logical-pixel offsets for both coordinates. Time values are not allowed.
• anchor.top or anchor.bottom: use chart x coordinates and finite pixel y offsets.
• anchor.left or anchor.right: use finite pixel x offsets and chart y coordinates.

Arrows support horizontal extensions only. The pool must use chart x coordinates, either without an anchor or with a top/bottom edge anchor. Other pools accept only null or extend.none. Vertical extensions are not allowed.

Available in Handlers and functions called from handlers.

entities.arrowPool.clear

entities.arrowPool.clear(key: int|time|duration|float|string, keys: int|time|duration|float|string...) -> bool

Clears arrows by key prefix.

Removes all arrows whose keys start with key and any additional keys, both from the pool and the chart. Returns true if at least one arrow was removed.

Returns bool

Available in Handlers and functions called from handlers.

entities.arrowPool.delete

entities.arrowPool.delete(key: int|time|duration|float|string, keys: int|time|duration|float|string...) -> bool

Deletes an arrow.

Removes the arrow for key and any additional keys from the pool and the chart. Returns true if it was removed, or false if those keys were not found.

Returns bool

Available in Handlers and functions called from handlers.

entities.arrowPool.get

entities.arrowPool.get(key: int|time|duration|float|string, keys: int|time|duration|float|string...) -> Arrow

Returns an arrow for the given keys.

Returns the arrow for key and any additional keys, creating one if needed. The result is never null. If the pool is full, the oldest arrow is removed. Call set to draw the new arrow.

Returns Arrow

Available in Handlers and functions called from handlers.

entities.arrowPool.has

entities.arrowPool.has(key: int|time|duration|float|string, keys: int|time|duration|float|string...) -> bool

Tests whether an arrow exists.

Returns true if the pool contains an arrow for key and any additional keys. This does not create, change, or draw anything.

Returns bool

Available in Handlers and functions called from handlers.

entities.box.set

entities.box.set(x1: time|int|float, y1: float, x2: time|int|float, y2: float, rounding: float = 0, color: color? = null, borderWidth: float = 0, borderColor: color? = null, borderStyle: LineStyle? = null, extend: Extend? = null, text: string = "", textColor: color? = null, textSize: float = 0, font: FontFamily? = null, textHAlign: string? = null, textVAlign: string? = null, textWrap: bool? = null, zIndex: int = 0) -> void

Draws or updates a box.

x1, y1, x2, and y2 set the corners.

• rounding rounds the corners and defaults to 0.0. Negative values stop the script with an error.
• color sets the fill color and defaults to null.
• borderWidth accepts 0.0 to 20.0, defaulting to 0.0. Other values stop the script with an error. borderColor and borderStyle default to null.
• extend stretches the box to pane edges: extend.left, extend.right, extend.both, extend.up, extend.down, or extend.vertical. Null leaves the box unextended.
• text adds a label, empty by default. textColor defaults to null.
• textSize accepts 0.0 to 96.0, defaulting to 0.0. Other values stop the script with an error. font defaults to font.app when null.
• textHAlign, textVAlign, and textWrap set text layout and default to null.
• zIndex sets the drawing order and defaults to 0.

Coordinates

The pool’s anchor determines how coordinates are measured:

• No anchor: use chart coordinates; x can be a time value.
• A pane anchor, such as anchor.topLeft: use finite logical-pixel offsets for both coordinates. Time values are not allowed.
• anchor.top or anchor.bottom: use chart x coordinates and finite pixel y offsets.
• anchor.left or anchor.right: use finite pixel x offsets and chart y coordinates.

Horizontal extensions need chart x coordinates: use a pool with no anchor or with a top/bottom edge anchor. Vertical extensions need chart y coordinates: use a pool with no anchor or with a left/right edge anchor. A pool using pixels for both coordinates accepts only null or extend.none.

Available in Handlers and functions called from handlers.

entities.boxPool.clear

entities.boxPool.clear(key: int|time|duration|float|string, keys: int|time|duration|float|string...) -> bool

Removes boxes whose keys start with the given keys.

Removes all boxes whose keys start with key and any additional keys, both from the pool and the chart. Returns true if at least one box was removed.

Returns bool

Available in Handlers and functions called from handlers.

entities.boxPool.delete

entities.boxPool.delete(key: int|time|duration|float|string, keys: int|time|duration|float|string...) -> bool

Deletes a box.

Removes the box for key and any additional keys from the pool and the chart. Returns true if it was removed, or false if those keys were not found.

Returns bool

Available in Handlers and functions called from handlers.

entities.boxPool.get

entities.boxPool.get(key: int|time|duration|float|string, keys: int|time|duration|float|string...) -> Box

Returns a box for the given keys.

Returns the box for key and any additional keys, creating one if needed. The result is never null. If the pool is full, the oldest box is removed. Call set to draw the new box.

Returns Box

Available in Handlers and functions called from handlers.

entities.boxPool.has

entities.boxPool.has(key: int|time|duration|float|string, keys: int|time|duration|float|string...) -> bool

Tests whether a box exists.

Returns true if the pool contains a box for key and any additional keys. This does not create, change, or draw anything.

Returns bool

Available in Handlers and functions called from handlers.

entities.label.set

entities.label.set(x: time|int|float, y: float, text: string, color: color? = null, size: float = 0, font: FontFamily? = null, textAlign: string? = null, zIndex: int = 0) -> void

Draws or updates a text label.

x and y set the position. The pool’s anchor also selects which point on the label is placed at that position. text supplies the label text.

• color uses the chart default when null.
• size accepts 0.0 to 96.0, defaulting to 0.0. Other values stop the script with an error.
• font defaults to font.app when null. textAlign defaults to null.
• zIndex sets the drawing order and defaults to 0.

Coordinates

The pool’s anchor determines how coordinates are measured:

• No anchor: use chart coordinates; x can be a time value.
• A pane anchor, such as anchor.topLeft: use finite logical-pixel offsets for both coordinates. Time values are not allowed.
• anchor.top or anchor.bottom: use chart x coordinates and finite pixel y offsets.
• anchor.left or anchor.right: use finite pixel x offsets and chart y coordinates.

Available in Handlers and functions called from handlers.

entities.labelPool.clear

entities.labelPool.clear(key: int|time|duration|float|string, keys: int|time|duration|float|string...) -> bool

Clears labels by key prefix.

Removes all labels whose keys start with key and any additional keys, both from the pool and the chart. Returns true if at least one label was removed.

Returns bool

Available in Handlers and functions called from handlers.

entities.labelPool.delete

entities.labelPool.delete(key: int|time|duration|float|string, keys: int|time|duration|float|string...) -> bool

Deletes a label.

Removes the label for key and any additional keys from the pool and the chart. Returns true if it was removed, or false if those keys were not found.

Returns bool

Available in Handlers and functions called from handlers.

entities.labelPool.get

entities.labelPool.get(key: int|time|duration|float|string, keys: int|time|duration|float|string...) -> Label

Returns a label for the given keys.

Returns the label for key and any additional keys, creating one if needed. The result is never null. If the pool is full, the oldest label is removed. Call set to draw the new label.

Returns Label

Available in Handlers and functions called from handlers.

entities.labelPool.has

entities.labelPool.has(key: int|time|duration|float|string, keys: int|time|duration|float|string...) -> bool

Tests whether a label exists.

Returns true if the pool contains a label for key and any additional keys. This does not create, change, or draw anything.

Returns bool

Available in Handlers and functions called from handlers.

entities.line.set

entities.line.set(x1: time|int|float, y1: float, x2: time|int|float, y2: float, width: float = 0, color: color? = null, style: LineStyle? = null, extend: Extend? = null, text: string = "", font: FontFamily? = null, zIndex: int = 0) -> void

Draws or updates a line.

x1, y1, x2, and y2 set the endpoints.

• width accepts 0.0 to 20.0, defaulting to 0.0. Other values stop the script with an error.
• color and style use chart defaults when null.
• extend continues the line toward the pane edges. Use extend.left, extend.right, or extend.both to follow its slope horizontally, or extend.up, extend.down, or extend.vertical to extend vertically. Null leaves the line unextended.
• text adds a label, empty by default. font defaults to font.app when null.
• zIndex sets the drawing order and defaults to 0.

Coordinates

The pool’s anchor determines how coordinates are measured:

• No anchor: use chart coordinates; x can be a time value.
• A pane anchor, such as anchor.topLeft: use finite logical-pixel offsets for both coordinates. Time values are not allowed.
• anchor.top or anchor.bottom: use chart x coordinates and finite pixel y offsets.
• anchor.left or anchor.right: use finite pixel x offsets and chart y coordinates.

Horizontal extensions need chart x coordinates: use a pool with no anchor or with a top/bottom edge anchor. Vertical extensions need chart y coordinates: use a pool with no anchor or with a left/right edge anchor. A pool using pixels for both coordinates accepts only null or extend.none. A horizontal line with a vertical extension spans the full visible width.

Available in Handlers and functions called from handlers.

entities.lineFill.set

entities.lineFill.set(lineA: Line, lineB: Line, color: color? = null) -> void

Draws or updates a fill between two lines.

lineA and lineB must be existing, drawn lines on the same pane. Both must use the same kind of positioning: chart coordinates, offsets from a pane point, or offsets from an edge. Their individual anchors may differ, such as one line anchored to the top and another to the bottom.

The fill follows both lines as they appear on the pane. color uses the chart default when null. Deleting either line also removes the fill; a null line cannot be used as a boundary.

Available in Handlers and functions called from handlers.

entities.lineFillPool.clear

entities.lineFillPool.clear(key: int|time|duration|float|string, keys: int|time|duration|float|string...) -> bool

Clears line fills by key prefix.

Removes all line fills whose keys start with key and any additional keys, both from the pool and the chart. Returns true if at least one line fill was removed.

Returns bool

Available in Handlers and functions called from handlers.

entities.lineFillPool.delete

entities.lineFillPool.delete(key: int|time|duration|float|string, keys: int|time|duration|float|string...) -> bool

Deletes a line fill.

Removes the line fill for key and any additional keys from the pool and the chart. Returns true if it was removed, or false if those keys were not found.

Returns bool

Available in Handlers and functions called from handlers.

entities.lineFillPool.get

entities.lineFillPool.get(key: int|time|duration|float|string, keys: int|time|duration|float|string...) -> LineFill

Returns a line fill for the given keys.

Returns the line fill for key and any additional keys, creating one if needed. The result is never null. If the pool is full, the oldest line fill is removed. Call set to draw the new line fill.

Returns LineFill

Available in Handlers and functions called from handlers.

entities.lineFillPool.has

entities.lineFillPool.has(key: int|time|duration|float|string, keys: int|time|duration|float|string...) -> bool

Tests whether a line fill exists.

Returns true if the pool contains a line fill for key and any additional keys. This does not create, change, or draw anything.

Returns bool

Available in Handlers and functions called from handlers.

entities.linePool.clear

entities.linePool.clear(key: int|time|duration|float|string, keys: int|time|duration|float|string...) -> bool

Clears lines by key prefix.

Removes all lines whose keys start with key and any additional keys, both from the pool and the chart. Returns true if at least one line was removed.

Returns bool

Available in Handlers and functions called from handlers.

entities.linePool.delete

entities.linePool.delete(key: int|time|duration|float|string, keys: int|time|duration|float|string...) -> bool

Deletes a line.

Removes the line for key and any additional keys from the pool and the chart. Returns true if it was removed, or false if those keys were not found.

Returns bool

Available in Handlers and functions called from handlers.

entities.linePool.get

entities.linePool.get(key: int|time|duration|float|string, keys: int|time|duration|float|string...) -> Line

Returns a line for the given keys.

Returns the line for key and any additional keys, creating one if needed. The result is never null. If the pool is full, the oldest line is removed. Call set to draw the new line.

Returns Line

Available in Handlers and functions called from handlers.

entities.linePool.has

entities.linePool.has(key: int|time|duration|float|string, keys: int|time|duration|float|string...) -> bool

Tests whether a line exists.

Returns true if the pool contains a line for key and any additional keys. This does not create, change, or draw anything.

Returns bool

Available in Handlers and functions called from handlers.

entities.marker.set

entities.marker.set(x: time|int|float, y: float, shape: Shape? = null, color: color? = null, size: float = 0, zIndex: int = 0) -> void

Draws or updates a marker.

x and y set the position.

• shape and color use chart defaults when null.
• size accepts 0.0 to 96.0, defaulting to 0.0. Other values stop the script with an error.
• zIndex sets the drawing order and defaults to 0.

Coordinates

The pool’s anchor determines how coordinates are measured:

• No anchor: use chart coordinates; x can be a time value.
• A pane anchor, such as anchor.topLeft: use finite logical-pixel offsets for both coordinates. Time values are not allowed.
• anchor.top or anchor.bottom: use chart x coordinates and finite pixel y offsets.
• anchor.left or anchor.right: use finite pixel x offsets and chart y coordinates.

Available in Handlers and functions called from handlers.

entities.markerPool.clear

entities.markerPool.clear(key: int|time|duration|float|string, keys: int|time|duration|float|string...) -> bool

Clears markers by key prefix.

Removes all markers whose keys start with key and any additional keys, both from the pool and the chart. Returns true if at least one marker was removed.

Returns bool

Available in Handlers and functions called from handlers.

entities.markerPool.delete

entities.markerPool.delete(key: int|time|duration|float|string, keys: int|time|duration|float|string...) -> bool

Deletes a marker.

Removes the marker for key and any additional keys from the pool and the chart. Returns true if it was removed, or false if those keys were not found.

Returns bool

Available in Handlers and functions called from handlers.

entities.markerPool.get

entities.markerPool.get(key: int|time|duration|float|string, keys: int|time|duration|float|string...) -> Marker

Returns a marker for the given keys.

Returns the marker for key and any additional keys, creating one if needed. The result is never null. If the pool is full, the oldest marker is removed. Call set to draw the new marker.

Returns Marker

Available in Handlers and functions called from handlers.

entities.markerPool.has

entities.markerPool.has(key: int|time|duration|float|string, keys: int|time|duration|float|string...) -> bool

Tests whether a marker exists.

Returns true if the pool contains a marker for key and any additional keys. This does not create, change, or draw anything.

Returns bool

Available in Handlers and functions called from handlers.

Properties

entities.arrowPool.capacity

entities.arrowPool.capacity: int

Returns the maximum number of arrows in the pool.

Returns the max value accepted for the arrow pool at setup. The capacity does not change during the run.

Returns int

Available in Handlers and functions called from handlers.

entities.arrowPool.isEmpty

entities.arrowPool.isEmpty: bool

Reports whether the arrow pool has no drawings.

Returns true when the pool contains no arrows. An arrow created with get counts even before it is drawn with set.

Returns bool

Available in Handlers and functions called from handlers.

entities.arrowPool.isFull

entities.arrowPool.isFull: bool

Reports whether the arrow pool is at capacity.

Returns true when the pool has reached its max count. You can still call get with new keys; doing so removes the oldest arrow.

Returns bool

Available in Handlers and functions called from handlers.

entities.arrowPool.len

entities.arrowPool.len: int

Counts the arrows currently in the pool.

Returns the number of arrows currently in the pool, including any created with get that have not yet been drawn. Removed arrows are not counted.

Returns int

Available in Handlers and functions called from handlers.

entities.boxPool.capacity

entities.boxPool.capacity: int

Returns the maximum number of boxes in the pool.

Returns the max value accepted for the box pool at setup. The capacity does not change during the run.

Returns int

Available in Handlers and functions called from handlers.

entities.boxPool.isEmpty

entities.boxPool.isEmpty: bool

Reports whether the box pool has no drawings.

Returns true when the pool contains no boxes. A box created with get counts even before it is drawn with set.

Returns bool

Available in Handlers and functions called from handlers.

entities.boxPool.isFull

entities.boxPool.isFull: bool

Reports whether the box pool is at capacity.

Returns true when the pool has reached its max count. You can still call get with new keys; doing so removes the oldest box.

Returns bool

Available in Handlers and functions called from handlers.

entities.boxPool.len

entities.boxPool.len: int

Counts the boxes currently in the pool.

Returns the number of boxes currently in the pool, including any created with get that have not yet been drawn. Removed boxes are not counted.

Returns int

Available in Handlers and functions called from handlers.

entities.labelPool.capacity

entities.labelPool.capacity: int

Returns the maximum number of labels in the pool.

Returns the max value accepted for the label pool at setup. The capacity does not change during the run.

Returns int

Available in Handlers and functions called from handlers.

entities.labelPool.isEmpty

entities.labelPool.isEmpty: bool

Reports whether the label pool has no drawings.

Returns true when the pool contains no labels. A label created with get counts even before it is drawn with set.

Returns bool

Available in Handlers and functions called from handlers.

entities.labelPool.isFull

entities.labelPool.isFull: bool

Reports whether the label pool is at capacity.

Returns true when the pool has reached its max count. You can still call get with new keys; doing so removes the oldest label.

Returns bool

Available in Handlers and functions called from handlers.

entities.labelPool.len

entities.labelPool.len: int

Counts the labels currently in the pool.

Returns the number of labels currently in the pool, including any created with get that have not yet been drawn. Removed labels are not counted.

Returns int

Available in Handlers and functions called from handlers.

entities.lineFillPool.capacity

entities.lineFillPool.capacity: int

Returns the maximum number of line fills in the pool.

Returns the max value accepted for the line fill pool at setup. The capacity does not change during the run.

Returns int

Available in Handlers and functions called from handlers.

entities.lineFillPool.isEmpty

entities.lineFillPool.isEmpty: bool

Reports whether the line fill pool has no drawings.

Returns true when the pool contains no line fills. A line fill created with get counts even before it is drawn with set.

Returns bool

Available in Handlers and functions called from handlers.

entities.lineFillPool.isFull

entities.lineFillPool.isFull: bool

Reports whether the line fill pool is at capacity.

Returns true when the pool has reached its max count. You can still call get with new keys; doing so removes the oldest line fill.

Returns bool

Available in Handlers and functions called from handlers.

entities.lineFillPool.len

entities.lineFillPool.len: int

Counts the line fills currently in the pool.

Returns the number of line fills currently in the pool, including any created with get that have not yet been drawn. Removed line fills are not counted.

Returns int

Available in Handlers and functions called from handlers.

entities.linePool.capacity

entities.linePool.capacity: int

Returns the maximum number of lines in the pool.

Returns the max value accepted for the line pool at setup. The capacity does not change during the run.

Returns int

Available in Handlers and functions called from handlers.

entities.linePool.isEmpty

entities.linePool.isEmpty: bool

Reports whether the line pool has no drawings.

Returns true when the pool contains no lines. A line created with get counts even before it is drawn with set.

Returns bool

Available in Handlers and functions called from handlers.

entities.linePool.isFull

entities.linePool.isFull: bool

Reports whether the line pool is at capacity.

Returns true when the pool has reached its max count. You can still call get with new keys; doing so removes the oldest line.

Returns bool

Available in Handlers and functions called from handlers.

entities.linePool.len

entities.linePool.len: int

Counts the lines currently in the pool.

Returns the number of lines currently in the pool, including any created with get that have not yet been drawn. Removed lines are not counted.

Returns int

Available in Handlers and functions called from handlers.

entities.markerPool.capacity

entities.markerPool.capacity: int

Returns the maximum number of markers in the pool.

Returns the max value accepted for the marker pool at setup. The capacity does not change during the run.

Returns int

Available in Handlers and functions called from handlers.

entities.markerPool.isEmpty

entities.markerPool.isEmpty: bool

Reports whether the marker pool has no drawings.

Returns true when the pool contains no markers. A marker created with get counts even before it is drawn with set.

Returns bool

Available in Handlers and functions called from handlers.

entities.markerPool.isFull

entities.markerPool.isFull: bool

Reports whether the marker pool is at capacity.

Returns true when the pool has reached its max count. You can still call get with new keys; doing so removes the oldest marker.

Returns bool

Available in Handlers and functions called from handlers.

entities.markerPool.len

entities.markerPool.len: int

Counts the markers currently in the pool.

Returns the number of markers currently in the pool, including any created with get that have not yet been drawn. Removed markers are not counted.

Returns int

Available in Handlers and functions called from handlers.

Constants