Difference between revisions of "Component: LinearGauge (Indicators)"

From Flowcode Help
Jump to navigationJump to search
(XML import)
 
 
(5 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
+
{| style="width:50%"
 
 
{| width="50%"
 
 
|-
 
|-
| width="20%" style="color: gray;" | Author
+
| width="20%" style="color:gray;" | Author
 
| Steve Tandy
 
| Steve Tandy
 
|-
 
|-
| width="20%" style="color: gray;" | Version
+
| width="20%" style="color:gray;" | Version
| 0.1 (Development)
+
| 1.0
 
|-
 
|-
| width="20%" style="color: gray;" | Category
+
| width="20%" style="color:gray;" | Category
 
| Indicators
 
| Indicators
 
|}
 
|}
  
  
 
+
==LinearGauge component==
==[[File:Component Icon 05e09581_b11d_46ae_b32d_c6414a6a922d.png|Image]] LinearGauge component==
 
 
A linear 2d gauge component.
 
A linear 2d gauge component.
  
==Examples==
+
==Component Pack==
''<span style="color:red;">No additional examples</span>''
 
  
 +
FREE
  
==Downloadable macro reference==
+
==Detailed description==
  
''This component does not contain any downloadable macros''
 
  
==Simulation macro reference==
 
  
===<span style="font-weight: normal;"><u><tt>GetValue</tt></u></span>===
 
Returns the current value of the component.
 
  
'''Parameters'''
 
  
:''This macro has no parameters''
 
  
  
'''Return value'''
 
  
:[[Variable Types|FLOAT]]
 
  
  
===<span style="font-weight: normal;"><u><tt>SetValue</tt></u></span>===
 
Sets the component to the specified value.
 
  
'''Parameters'''
+
''No detailed description exists yet for this component''
  
:[[Variable Types|FLOAT]] ''value''
+
==Examples==
::A new value for the component.
 
  
  
'''Return value'''
 
  
:''This call does not return a value''
 
  
  
  
  
==Property reference==
 
<span style="font-weight: normal;"><u>Value</u></span>
 
  
This property is of type ''Floating point'' and can be referenced with the variable name ''Base2dGauge::Base2dObject::dValue''.
 
  
''<span style="color:red;">No additional information</span>''
 
  
  
  
<span style="font-weight: normal;"><u>Style</u></span>
+
''<span style="color:red;">No additional examples</span>''
  
This property is of type ''Fixed list of text'' and can be referenced with the variable name ''nStyle''.
 
  
''<span style="color:red;">No additional information</span>''
+
==Downloadable macro reference==
  
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetValue'''
 +
|-
 +
| colspan="2" | Returns the current value of the component.&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-f32-icon.png]] - FLOAT
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
  
  
<span style="font-weight: normal;"><u>Orientation</u></span>
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetValue'''
 +
|-
 +
| colspan="2" | Sets the component to the specified value.&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
 +
| width="90%" | value
 +
|-
 +
| colspan="2" | A new value for the component.&nbsp;
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
  
This property is of type ''Fixed list of text'' and can be referenced with the variable name ''nOrientation''.
 
  
''<span style="color:red;">No additional information</span>''
 
  
  
 +
==Property reference==
  
<span style="font-weight: normal;"><u>Pointer</u></span>
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
+
|-
This property is of type ''Fixed list of text'' and can be referenced with the variable name ''nPointer''.
+
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
 
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''  
''<span style="color:red;">No additional information</span>''
+
|-
 
+
|-
 
+
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
 
+
| width="90%" | Value
<span style="font-weight: normal;"><u>Lower Bound</u></span>
+
|-
 
+
| colspan="2" | &nbsp;
This property is of type ''Floating point'' and can be referenced with the variable name ''Base2dGauge::dLowerBound''.
+
|-
 
+
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
The bottom value of the scale.
+
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Appearance
 
+
|-
<span style="font-weight: normal;"><u>Upper Bound</u></span>
+
|-
 
+
| width="10%" align="center" | [[File:Fc9-type-12-icon.png]]
This property is of type ''Floating point'' and can be referenced with the variable name ''Base2dGauge::dUpperBound''.
+
| width="90%" | Style
 
+
|-
The top value of the scale.
+
| colspan="2" | &nbsp;
 
+
|-
<span style="font-weight: normal;"><u>Major Tick Step</u></span>
+
| width="10%" align="center" | [[File:Fc9-type-12-icon.png]]
 
+
| width="90%" | Orientation
This property is of type ''Unsigned integer'' and can be referenced with the variable name ''Base2dGauge::dMajorTickStep''.
+
|-
 
+
| colspan="2" | &nbsp;
The number of minor tick marks to show a major tick mark value.
+
|-
 
+
| width="10%" align="center" | [[File:Fc9-type-12-icon.png]]
<span style="font-weight: normal;"><u>Minor Tick Step</u></span>
+
| width="90%" | Pointer
 
+
|-
This property is of type ''Floating point'' and can be referenced with the variable name ''Base2dGauge::dMinorTickStep''.
+
| colspan="2" | &nbsp;
 
+
|-
The scale value between consecutive minor tick marks.
+
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 +
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Range
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
 +
| width="90%" | Lower Bound
 +
|-
 +
| colspan="2" | The bottom value of the scale.&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
 +
| width="90%" | Upper Bound
 +
|-
 +
| colspan="2" | The top value of the scale.&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
 +
| width="90%" | Major Tick Step
 +
|-
 +
| colspan="2" | The number of minor tick marks to show a major tick mark value.&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
 +
| width="90%" | Minor Tick Step
 +
|-
 +
| colspan="2" | The scale value between consecutive minor tick marks.&nbsp;
 +
|}

Latest revision as of 17:19, 9 November 2022

Author Steve Tandy
Version 1.0
Category Indicators


LinearGauge component

A linear 2d gauge component.

Component Pack

FREE

Detailed description

No detailed description exists yet for this component

Examples

No additional examples


Downloadable macro reference

Fc9-comp-macro.png GetValue
Returns the current value of the component. 
Fc9-f32-icon.png - FLOAT Return


Fc9-comp-macro.png SetValue
Sets the component to the specified value. 
Fc9-f32-icon.png - FLOAT value
A new value for the component. 
Fc9-void-icon.png - VOID Return



Property reference

Fc9-prop-icon.png Properties
Fc9-type-15-icon.png Value
 
Fc9-conn-icon.png Appearance
Fc9-type-12-icon.png Style
 
Fc9-type-12-icon.png Orientation
 
Fc9-type-12-icon.png Pointer
 
Fc9-conn-icon.png Range
Fc9-type-15-icon.png Lower Bound
The bottom value of the scale. 
Fc9-type-15-icon.png Upper Bound
The top value of the scale. 
Fc9-type-21-icon.png Major Tick Step
The number of minor tick marks to show a major tick mark value. 
Fc9-type-15-icon.png Minor Tick Step
The scale value between consecutive minor tick marks.