Valve

About 5 min read

TwValve · Category: Svg

Settings

These settings are in the properties panel on the right while the widget is selected, mostly in the Valve Settings section. The default value is the value the widget has when it is first added to a page.

State

Setting	Type	Default	Description
State state	Selection	open	Valve state, usually bound to a tag: Open, Closed, Partially Open or Fault. Each state has its own color and disc position. Options: open Open, closed Closed, partial Partially Open, fault Fault
Show Flow Arrows showFlowArrow	Checkbox	On	Shows flow arrows; they only appear in the Open and Partially Open states.
Show State Label showStateLabel	Checkbox	On	Shows a short state text: OPEN, CLOSED, PART or FAULT.
Flow Direction flowDirection	Selection	forward	Direction of the flow arrows: Forward follows Direction, Reverse runs against it. Options: forward Forward, reverse Reverse
Animate Flow animateFlow	Checkbox	On	Animates the flow arrows, and the flow path in the Partially Open state.
Flow Animation Duration flowSpeed	Number	1.8	Duration of one flow animation cycle in seconds, 0.4–8 (default 1.8); larger values are slower.

Structure

Setting	Type	Default	Description
Valve Type valveType	Selection	2way	2-way valve, or 3-way valve with an additional branch connection. Options: 2way 2-Way, 3way 3-Way
Direction direction	Selection	right	Orientation of the valve; the whole drawing is rotated to Right, Down, Left or Up. Options: right Right, down Down, left Left, up Up
Show Actuator showActuator	Checkbox	On	Shows the actuator above the valve body.
Branch Side branchSide	Selection	up	Side of the branch connection: Up or Down. Only used with the 3-Way valve type. Options: up Up, down Down
Actuator Type actuatorType	Selection	electric	Actuator drawn on the valve: Electric, Pneumatic or Manual (handwheel). Only shown when Show Actuator is on. Options: electric Electric, pneumatic Pneumatic, manual Manual
Show Flanges showFlanges	Checkbox	On	Draws flanges between the valve body and the pipe connections.

Appearance

Setting	Type	Default	Description
Render Mode renderMode	Selection	realistic	Realistic draws a metal body with a colored state lens; Flat fills the body with the state color. Options: flat Flat, realistic Realistic
Line Style lineStyle	Selection	pipe	Pipe draws thick pipe connections; Normal draws thin connection lines. Options: normal Normal, pipe Pipe
Body Material bodyMaterial	Selection	steel	Body material: Steel, Dark, Brass or Custom. Custom uses Custom Body Color. Options: steel Steel, dark Dark, brass Brass, custom Custom
Shadow Enabled shadowEnabled	Checkbox	On	Draws a soft shadow under the valve.

Colors

Setting	Type	Default	Description
Open Color openColor	Color	#22c55e	Color of the Open state, used for the state lens or, in the Flat render mode, the whole body.
Partial Color partialColor	Color	#f59e0b	Color of the Partially Open state, used for the state lens or, in the Flat render mode, the whole body.
Actuator Color actuatorColor	Color	#64748b	Base color of the actuator.
Closed Color closedColor	Color	#ef4444	Color of the Closed state, used for the state lens or, in the Flat render mode, the whole body.
Fault Color faultColor	Color	#dc2626	Color of the Fault state, used for the state lens or, in the Flat render mode, the whole body.
Custom Body Color fillColor	Color	#94a3b8	Body color used when Body Material is Custom.

Line

Setting	Type	Default	Description
Stroke Color strokeColor	Color	#334155	Outline color of the shape.
Stroke Opacity strokeOpacity	Number	1	Outline transparency. 0 is fully transparent, 1 is fully opaque.
Stroke Width strokeWidth	Number	3	Base width of edges, stem and flow lines, 0.5–8 (default 3).

Other settings

Setting	Type	Default	Description
Enable Flashing enableFlashing	Checkbox	Off	Makes the widget blink (an opacity pulse every second). Usually bound to an alarm condition.
Log Button logButton	Checkbox	Off	At runtime shows a chart icon when hovering the widget; clicking it adds the Tags bound to the widget to the log Tag list.
Fill opacity fillOpacity	Number	100	Fill transparency. 0 is fully transparent, 1 is fully opaque.
Dash pattern strokeDashArray	Text	—	Dash pattern for outline, for example: 5,3
Hover color hoverColor	Color	#097979	Color used when pointer hovers over the shape.

Bindings

In the Bindings (Rules) section of the properties panel, a Tag can be bound to the following properties of this widget with a Direct binding. The binding types (Direct, IntRange, FloatRange, Boolean, Bit) are the same for all widgets; they are described on the Widget Reference page.

title, visible, authorization, x, y, width, height, rotation, class, foregroundColor, backgroundColor, borderColor, borderStyle, borderWidth, borderRadius, borderTopLeftRadius, borderTopRightRadius, enableFlashing, logButton, to.type, fillColor, fillOpacity, strokeColor, strokeOpacity, strokeWidth, strokeDashArray, hoverColor, state, valveType, branchSide, renderMode, direction, flowDirection, lineStyle, actuatorType, bodyMaterial, showActuator, showFlowArrow, showFlanges, showStateLabel, animateFlow, shadowEnabled, openColor, closedColor, partialColor, faultColor, actuatorColor, flowSpeed

Common sections

While this widget is selected, the properties panel also shows these common sections: General, Layout, Appearance, Drawing, Navigation (To), Bindings (Rules). These sections are described on the Page Editor page.