Last updated: Feb 11, 2025
The Collection node shows the distribution of values for one
numeric field relative to the values of another. (It creates graphs that are similar to histograms.)
It's useful for illustrating a variable or field whose values change over time. Using 3-D graphing,
you can also include a symbolic axis displaying distributions by category.
Example
stream = modeler.script.stream()
typenode = stream.findByID("id42KW3MSA94B")
node = stream.create("collection", "My node")
stream.link(typenode, node)
# "Plot" tab
node.setPropertyValue("three_D", True)
node.setPropertyValue("collect_field", "Drug")
node.setPropertyValue("over_field", "Age")
node.setPropertyValue("by_field", "BP")
node.setPropertyValue("operation", "Sum")
node.setPropertyValue("color_field", "Drug")
node.setPropertyValue("panel_field", "Sex")
# "Options" tab
node.setPropertyValue("range_mode", "Automatic")
node.setPropertyValue("range_min", 1)
node.setPropertyValue("range_max", 100)
node.setPropertyValue("bins", "ByNumber")
node.setPropertyValue("num_bins", 10)
node.setPropertyValue("bin_width", 5)
collectionnode properties |
Data type | Property description |
|---|---|---|
over_field
|
field | |
over_label_auto
|
flag | |
over_label
|
string | |
collect_field
|
field | |
collect_label_auto
|
flag | |
collect_label
|
string | |
three_D
|
flag | |
by_field
|
field | |
by_label_auto
|
flag | |
by_label
|
string | |
operation
|
Sum
Mean
Min
Max
SDev
|
|
color_field
|
string | |
panel_field
|
string | |
animation_field
|
string | |
range_mode
|
Automatic
UserDefined
|
|
range_min
|
number | |
range_max
|
number | |
bins
|
ByNumber
ByWidth
|
|
num_bins
|
number | |
bin_width
|
number | |
use_grid
|
flag | |
graph_background
|
color | Standard graph colors are described at the beginning of this section. |
page_background
|
color | Standard graph colors are described at the beginning of this section. |