Appearance
Heat Trace Line
A heat traced pipe run drawn in true isometric, with its cable, markers, lengths and a live pipe temperature.
In Studio
In Studio, double-click Heat Trace Line in the Components category of the Components panel. It is added to the open view, where you can drag it into place.
When to use
Use Heat Trace Line on a circuit detail screen to show where the cable runs and what the heater is doing: energized, off, tripped on a ground fault, or open. The run is described once as a short list of straight segments, so it suits any traced line, not only one project.
Properties
| Property | Type | Default | Description |
|---|---|---|---|
| Run (JSON) | String | {"pipeNominalIn":2,"units":"ft","flow":"forward","paths":[{"id":"main","run":[{"dir":"W","len":20},{"dir":"N","len":40},{"dir":"U","len":8}],"marks":[{"at":0,"type":"kit"},{"at":30,"type":"rtd"},{"at":"end","type":"seal"}]}]} | The run, as JSON text (or an object bound to the property). It has pipeNominalIn (pipe size in inches, default 2), units (ft or m, default ft), flow (forward or reverse, the direction of the flow arrow) and paths. Each path is {id, from, run, marks}. run is a list of segments {dir, len, buried}: dir is N, S, E, W (the ground plane, drawn at 30 degrees) or U, D (vertical), or a 45 degree pair of two perpendicular axes: NE, NW, SE, SW in the ground plane (a plan offset) and NU, ND, SU, SD, EU, ED, WU, WD in a vertical plane (a rolling offset). len is the true length along the segment in the chosen units, so a diagonal leg of 21.7 is 21.7 long, not 21.7 on each axis, and buried: true puts that stretch below grade. from is {path, at} and starts the path on an earlier path at that distance (a tee or a branch). marks is a list of {at, type, len}: at is a distance along the path or "end", and type is kit (power kit), rtd, seal (end seal), splice, tee, flange, valve, checkvalve, strainer, sightglass, reducer or hose. len is optional and is the face-to-face length of an inline component (the valve, check valve and Y-strainer are the P&ID symbols the product already has, scaled to that length; the reducer, sight glass and hose are drawn for this component); the symbol is drawn that long, centered on at, and is held inside its segment, so a mark near a bend or an end is shortened rather than drawn across it; len must be above 0 and at most 20 (in the chosen units); outside that the mark is drawn at its default size and the component says so. A path that has both origin and from uses from, and the component says the origin was ignored. A path may also carry startNote and endNote (up to 60 characters), drawn at its first and last point with an open circle, for what the drawing does not show, such as Sheet 2 not supplied or to PW-2-9226. A path with no from may carry origin, [east, north, up] always in feet (it does not follow units) from the start of the first path, to place a stretch that is not connected to the rest in the drawing (the sheet of a line that stands on another line, or what follows a sheet that was not supplied). Two flags on the config: sizeTbd (no size printed: the caption reads Size TBD) and unverified (the drawing did not pass every check: it says Drawing not fully verified). A segment that is wrong, such as a bad direction, a length of 0 or a length over 5000, is left out and the component says which. Limits: pipe size 0.25 to 48 in (outside that it is clamped), at most 32 paths, 200 segments and 100 marks per path. |
| Pipe Temp | String | (none) | The pipe temperature, from the RTD. It tints the pipe (from the Cold Pipe Tint color to the At-Setpoint Pipe Tint color) and is the reading on every RTD callout. With no value the pipe is drawn in its neutral color and the callout reads --. |
| Setpoint | String | (none) | The temperature setpoint the tint is measured against. The tint runs from 10 degrees below setpoint (cold) to setpoint (ok). |
| Energized | String | (none) | Whether the heater output is on. A true value or 1 draws the cable energized: solid and heavy, with moving beads and an ON pill. |
| Cable State | String | (none) | Optional override of the cable's look: on, off, trip or open. Leave it blank to derive it: a ground fault trip is trip, an open circuit is open, an energized heater is on, anything else is off. |
| Low Temp Alarm | String | (none) | True while the low temperature alarm is active. The RTD callout takes the priority 1 square and outline, with a down arrow. |
| Ground Fault Trip | String | (none) | True while the ground fault has tripped the circuit. The cable is drawn off, the pill reads TRIP, and a priority 1 square sits beside it. |
| Open Circuit Alarm | String | (none) | True while the cable is open (no heater current). The cable is dotted, the pill reads NO CURRENT, and a priority 2 triangle with a question mark is drawn along the cable, because the break location is not known. |
| Temp Unit Text | String | °F | The text after the RTD reading. Default °F. |
| Tint Spread (deg) | Number | 3.4 | How many degrees cooler the drawn pipe tint runs from the power kit end to the far end of the run. One sensor reads one place, so this is an illustration; set 0 to tint the whole run the same. Default 3.4. |
| Show Lengths | true, false | true | Shows the length of each straight stretch beside the pipe. A label that would land on another is left out. |
| Show Legend | true, false | true | Shows the legend of the markers the drawing uses, with the cable key. Grade and Not traced appear when part of the run is below grade. |
| Show Compass | true, false | true | Shows the isometric compass in the top left corner: N, E, S and W along the same axes the pipe is drawn on (N emphasized), and a short Up arm. Default true. |
| View | auto, 0, 1, 2, 3 | auto | Which way the drawing is turned. auto (the default) picks the cleanest of the four quarter turns of the plan; 0, 1, 2 or 3 pins that turn, so the drawing keeps its look when the run is edited. 0 is north up and to the right. Pin a view on a screen that has been signed off. |
| Pipe Color | Color | #F7F7F7 | The pipe body when no temperature is known. Every color of the drawing is a property with one built-in default; set it to a color, or to a var(--name) that a style class defines so a project can restyle the drawing with the rest of its screen. |
| Pipe Edge Color | Color | #333333 | The pipe outline, the markers' outlines and the soil band. |
| Cable On Color | Color | #000000 | The cable while it is energized. |
| Cable Off Color | Color | #808080 | The cable while it is off. |
| Cold Pipe Tint | Color | #F7F7F7 | The pipe tint at 40 degrees or colder. Between this and the At-Setpoint Pipe Tint the tint is mixed by temperature. |
| At-Setpoint Pipe Tint | Color | #F7F7F7 | The pipe tint at setpoint. |
| Stale Pipe Tint | Color | #E0E0E0 | The pipe body while the data is stale or bad. |
| ON Pill Color | Color | #333333 | The fill of the ON pill on an energized cable. |
| ON Pill Text Color | Color | #FFFFFF | The text on the ON pill. Keep it readable on the pill color. |
| Cable Bead Color | Color | #000000 | The beads that travel along an energized cable. |
| Leader Line Color | Color | #666666 | The leader lines from a marker or an RTD to its label. |
| Label Fill Color | Color | #E8E8E8 | The fill of the label boxes and of the markers drawn on the pipe. |
| Text Color | Color | #333333 | Text on the drawing: lengths, the caption and labels. |
| Dim Text Color | Color | #666666 | Quieter text: the legend, the compass and the RTD name. |
| Value Text Color | Color | #000000 | The RTD reading and the emphasized figure in the caption. |
| Border Color | Color | #B0B0B0 | The border of the label boxes and of the pill states that have no alarm. |
| Stale Hatch Color | Color | #9E9E9E | The hatch drawn over the whole drawing while its data is stale or bad. |
| Alarm Text Color | Color | #E12D39 | Alarm text on the drawing: the low temperature arrow and the TRIP pill text. The alarm shapes keep the locked alarm colors. |
| Warning Text Color | Color | #F57C00 | The warning text for a run the drawing could not draw in full (a bad segment). |
| Quality Mark | standard, dim | standard | How a lost link is marked when a value this component shows has Stale or Bad quality. standard (the default) draws the quality outline and glyph over the value. dim keeps the last good value on screen, faded, with nothing drawn over it: it suits a dense panel where one lost link turns a whole column Bad. The value still reads as not live, and a binding that fails to evaluate keeps its outline either way. |
Binding
This component has no single value binding.
Heat Trace Line only displays. Bind pipeTemp, setpoint, energized, lowTempAlarm, gfAlarm and openAlarm to tags. When any bound tag has bad or stale quality the drawing is hatched, the pill reads STALE and the last values are shown in gray. In a parameterized popup, bind config to a popup parameter so one popup serves every circuit.
Which way the drawing faces
True isometric draws a 45 degree plan run going SE or NW straight up and down the screen, so it can land on top of a riser. The line turns its drawing in quarter turns to keep pipe from being drawn over other pipe, then to cross itself as few times as possible, and the compass turns with it. A line that draws cleanly as written keeps north up and to the right. A turn never sends a buried leg up the screen. Where one pipe passes over another, the nearer one is drawn whole and the one behind has a short gap; the gap never reaches past the straight stretch it belongs to, so a bend close to a crossing stays whole. Set View to 0 to 3 to pin the turn instead of letting the line choose.
Below grade
A segment with buried: true is drawn as hidden-line pipe: a dashed outline, a lighter fill, no temperature tint and no cable. A short ground line (a horizontal line with diagonal ticks) crosses the pipe wherever the run goes into or comes out of the ground, a cable end seal is drawn where tracing stops going down, a light hatched soil band is shaded below the grade line, and a label gives the buried length. Write buried legs so they go down the screen (D, S or E): they then read as underground, and the drawing is not turned in a way that sends them up. For a pipe that comes up out of the ground, write the run from the far end toward the ground. The Traced length at the top counts only the traced pipe and reads Traced 82 ft of 95 ft pipe (lengths read to one decimal under 10 and in whole units from 10 up) when part of it is buried. Put the power kit at the grade line to start tracing there.
Example
json
{"pipeNominalIn":2,"units":"ft","flow":"forward","paths":[{"id":"main","run":[{"dir":"U","len":3,"buried":true},{"dir":"U","len":6},{"dir":"E","len":20}],"marks":[{"at":3,"type":"kit"},{"at":18,"type":"rtd"},{"at":"end","type":"seal"}]}]}