===== Fan =====

com.ergotech.vib.graphics.Fan

==== Image Examples ====

| {{:mistudio:graphics:more_layout:status_motion:pasted:20260701-170121.png?40|Fan in the graphics palette}} | {{:mistudio:graphics:more_layout:status_motion:pasted:20260701-170219.png?40|Fan graphic example}} |
| //Fan in the graphics palette.// | //Fan graphic example.// |

==== Overview ====

The Fan graphic is a More Layout process graphic used to display an animated fan.

Fan animation is controlled by the incoming input value. When the input value is above the configured low value, the fan can animate to show running or active behavior.

Fan is closely related to Pump, but it does not include pipe input or output connections.

==== Common Uses ====

  * Displaying fan status
  * Showing fan running or stopped behavior
  * Representing rotating equipment in an operator screen
  * Showing animated process movement
  * Building equipment displays
  * Displaying a motorized or ventilation-style graphic

==== Input Behavior ====

Fan accepts input through **valueInput**.

The input can come from a data source, Constant, or another logic component.

Numeric input controls the fan animation behavior.

The input value is scaled between the configured **Low Value** and **High Value**.

==== Output Behavior ====

Fan has no default output ports.

Fan is used as an animated display graphic.

==== Fan-Specific Behavior ====

Fan displays a fan body with animated fan blade movement.

Fan-specific settings include:

  * **Name** Sets the name of the Fan graphic.
  * **Base** Controls whether the Fan has a base and where the base is drawn.
  * **Shading Detail** Controls the amount of shading detail used for the fan body.
  * **Fan Direction** Controls whether the fan animation moves forward or reverse.
  * **Fan Color** Sets the color of the fan blades.
  * **Fan Segments** Sets the number of fan blades.
  * **High Value** Sets the high end of the input range.
  * **Low Value** Sets the low end of the input range.
  * **Shading Inside Off** Sets the inside shading color when the Fan is off.
  * **Shading Inside On** Sets the inside shading color when the Fan is on.
  * **Shading Outside** Sets the outside shading color for the fan body.
  * **Speed** Selects the animation speed range.
  * **Fan Stop at Min** Controls whether the fan stops at the minimum value.
  * **Use Color** Controls whether incoming server colors are used for the active display.
  * **Bad Qual. Indicator** Controls the indicator used when bad quality data is received.
  * **Bezel** Sets the bezel style.
  * **Bezel Color** Sets the outside bezel color.
  * **Bezel Inside Color** Sets the inside bezel color.
  * **Bezel Thickness** Sets the thickness of the bezel.
  * **Fan Size** Sets the fan blade size relative to the fan body.
  * **Cursor** Sets the cursor shown when the pointer is over the Fan.
  * **Rotation** Sets the Fan rotation.
  * **Click Action** Defines a click action.
  * **Click Count** Sets the number of clicks used for the click action.
  * **Visible** Controls whether the Fan is shown.
  * **Warning Qual. Indicator** Controls the indicator used when warning or transitional quality data is received.

==== Logic Ports ====

In the Logic Editor, Fan includes this default port:

  * **valueInput**

The **valueInput** port updates the Fan animation behavior from a data source, Constant, or another logic component.

==== Animation Behavior ====

Fan uses the incoming value to control whether the fan is running and how the fan blade animation behaves.

The **Low Value** and **High Value** properties define the input range used for scaling.

The **Speed** property selects the animation speed range.

The **Fan Direction** property controls the direction of fan blade movement.

The **Fan Stop at Min** property controls whether the fan stops when the input is at the minimum value.

==== Notes ====

Use Fan when an application needs an animated fan-style equipment display without pipe connections.

Use [[mistudio:design_editor:more_layout:status_motion:pump|Pump]] for a similar animated graphic that includes process pipe connections.

Use [[mistudio:design_editor:more_layout:status_motion:chaser|Chaser]] for a simpler animated motion or flow display.

For general graphic behavior, see [[mistudio:design_editor:active_graphic|Active Graphic]].

==== Related Pages ====

  * [[mistudio:design_editor:start|MIStudio Design Editor]]
  * [[mistudio:design_editor:more_layout:start|More Layout]]
  * [[mistudio:design_editor:more_layout:status_motion:start|Status, Motion, and Process Graphics]]
  * [[mistudio:design_editor:more_layout:status_motion:pump|Pump]]
  * [[mistudio:design_editor:more_layout:status_motion:chaser|Chaser]]
  * [[mistudio:design_editor:active_graphic|Active Graphic]]