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

From Flowcode Help
Jump to navigationJump to search
(XML import)
 
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==
+
==Detailed description==
−
''<span style="color:red;">No additional examples</span>''
 
  
 +
''No detailed description exists yet for this component''
  
−
==Downloadable macro reference==
+
==Examples==
  
−
''This component does not contain any downloadable macros''
 
  
−
==Simulation macro reference==
+
''<span style="color:red;">No additional examples</span>''
  
−
===<span style="font-weight: normal;"><u><tt>GetValue</tt></u></span>===
 
−
Returns the current value of the component.
 
  
−
'''Parameters'''
+
==Downloadable macro reference==
  
−
:''This macro has no parameters''
+
{| 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:]] -
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
  
  
−
'''Return value'''
+
{| 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:]] -
 +
| 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''
 +
|}
  
−
:[[Variable Types|FLOAT]]
 
  
 +
{| 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:]] -
 +
| 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''
 +
|}
  
−
===<span style="font-weight: normal;"><u><tt>SetValue</tt></u></span>===
 
−
Sets the component to the specified value.
 
  
−
'''Parameters'''
+
{| 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;" | '''RefreshChart'''
 +
|-
 +
| colspan="2" | Redraws the chart.&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''
 +
|}
  
−
:[[Variable Types|FLOAT]] ''value''
 
−
::A new value for the component.
 
  
 +
{| 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;" | '''GetData'''
 +
|-
 +
| colspan="2" | Gets a data point from the specified series.&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Series
 +
|-
 +
| colspan="2" | Which series to add to (1-8)&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:]] -
 +
| width="90%" | Index
 +
|-
 +
| colspan="2" | The data point index (1 - 32767)&nbsp;
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:]] -
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
  
−
'''Return value'''
 
  
−
:''This call does not return a value''
+
{| 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;" | '''AddDataCXYY1'''
 +
|-
 +
| colspan="2" | Adds a data point to a bubble chart.&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Series
 +
|-
 +
| colspan="2" | Which series to add to (1-8)&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
 +
| width="90%" | Category
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:]] -
 +
| width="90%" | Y
 +
|-
 +
| colspan="2" | Y coordinate&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:]] -
 +
| width="90%" | X
 +
|-
 +
| colspan="2" | X coordinate&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:]] -
 +
| width="90%" | Value
 +
|-
 +
| colspan="2" | The value of the data point&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''
 +
|}
  
  
Line 58: Line 153:
  
 
==Property reference==
 
==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''.
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
−
 
+
|-
−
''<span style="color:red;">No additional information</span>''
+
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
−
 
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''  
−
 
+
|-
−
 
+
|-
−
<span style="font-weight: normal;"><u>Style</u></span>
+
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
−
 
+
| width="90%" | Value
−
This property is of type ''Fixed list of text'' and can be referenced with the variable name ''nStyle''.
+
|-
−
 
+
| colspan="2" | &nbsp;
−
''<span style="color:red;">No additional information</span>''
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-12-icon.png]]
−
 
+
| width="90%" | Style
−
 
+
|-
−
<span style="font-weight: normal;"><u>Orientation</u></span>
+
| colspan="2" | &nbsp;
−
 
+
|-
−
This property is of type ''Fixed list of text'' and can be referenced with the variable name ''nOrientation''.
+
| width="10%" align="center" | [[File:Fc9-type-12-icon.png]]
−
 
+
| width="90%" | Orientation
−
''<span style="color:red;">No additional information</span>''
+
|-
−
 
+
| colspan="2" | &nbsp;
−
 
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-12-icon.png]]
−
<span style="font-weight: normal;"><u>Pointer</u></span>
+
| width="90%" | Pointer
−
 
+
|-
−
This property is of type ''Fixed list of text'' and can be referenced with the variable name ''nPointer''.
+
| colspan="2" | &nbsp;
−
 
+
|-
−
''<span style="color:red;">No additional information</span>''
+
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
−
 
+
| width="90%" | Lower Bound
−
 
+
|-
−
 
+
| colspan="2" | The bottom value of the scale.&nbsp;
−
<span style="font-weight: normal;"><u>Lower Bound</u></span>
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
−
This property is of type ''Floating point'' and can be referenced with the variable name ''Base2dGauge::dLowerBound''.
+
| width="90%" | Upper Bound
−
 
+
|-
−
The bottom value of the scale.
+
| colspan="2" | The top value of the scale.&nbsp;
−
 
+
|-
−
<span style="font-weight: normal;"><u>Upper Bound</u></span>
+
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
−
 
+
| width="90%" | Major Tick Step
−
This property is of type ''Floating point'' and can be referenced with the variable name ''Base2dGauge::dUpperBound''.
+
|-
−
 
+
| colspan="2" | The number of minor tick marks to show a major tick mark value.&nbsp;
−
The top value of the scale.
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
−
<span style="font-weight: normal;"><u>Major Tick Step</u></span>
+
| width="90%" | Minor Tick Step
−
 
+
|-
−
This property is of type ''Unsigned integer'' and can be referenced with the variable name ''Base2dGauge::dMajorTickStep''.
+
| colspan="2" | The scale value between consecutive minor tick marks.&nbsp;
−
 
+
|-
−
The number of minor tick marks to show a major tick mark value.
+
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-conn-icon.png]]
−
 
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Connections'''  
−
<span style="font-weight: normal;"><u>Minor Tick Step</u></span>
+
|-
−
 
+
|-
−
This property is of type ''Floating point'' and can be referenced with the variable name ''Base2dGauge::dMinorTickStep''.
+
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-conn-icon.png]]
−
 
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Simulations'''  
−
The scale value between consecutive minor tick marks.
+
|-
 +
|}

Revision as of 16:52, 16 November 2021

Author Steve Tandy
Version 1.0
Category Indicators


LinearGauge component

A linear 2d gauge component.

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. 
[[File:]] - Return


Fc9-comp-macro.png SetValue
Sets the component to the specified value. 
[[File:]] - value
A new value for the component. 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png SetValue
Sets the component to the specified value. 
[[File:]] - value
A new value for the component. 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png RefreshChart
Redraws the chart. 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png GetData
Gets a data point from the specified series. 
Fc9-u8-icon.png - BYTE Series
Which series to add to (1-8) 
[[File:]] - Index
The data point index (1 - 32767) 
[[File:]] - Return


Fc9-comp-macro.png AddDataCXYY1
Adds a data point to a bubble chart. 
Fc9-u8-icon.png - BYTE Series
Which series to add to (1-8) 
Fc9-string-icon.png - STRING Category
 
[[File:]] - Y
Y coordinate 
[[File:]] - X
X coordinate 
[[File:]] - Value
The value of the data point 
Fc9-void-icon.png - VOID Return



Property reference

Fc9-prop-icon.png Properties
Fc9-type-15-icon.png Value
 
Fc9-type-12-icon.png Style
 
Fc9-type-12-icon.png Orientation
 
Fc9-type-12-icon.png Pointer
 
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. 
Fc9-conn-icon.png Connections
Fc9-conn-icon.png Simulations
Retrieved from "https://www.flowcode.co.uk/wikiv9/index.php?title=Component:_LinearGauge_(Indicators)&oldid=25111"