Jump to content

Component: Numeric Indicator (Indicators): Difference between revisions

From Flowcode Help
Newer edit →

Wiki bot (talk | contribs)

3 user groups
14,227 edits
XML import
 
No edit summary
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
|}
|}




==Numeric Indicator component==
A 2d numeric indicator component.
==Detailed description==


==[[File:Component Icon f959d1c6_e0be_415b_abd6_da5b386638f3.png|Image]] Numeric Indicator component==
''No detailed description exists yet for this component''
A 2d numeric indicator component.


==Examples==
==Examples==
''<span style="color:red;">No additional examples</span>''
''<span style="color:red;">No additional examples</span>''


Line 24: Line 27:
==Downloadable macro reference==
==Downloadable macro reference==


''This component does not contain any downloadable macros''
{| 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''
|}


==Simulation macro reference==


===<span style="font-weight: normal;"><u><tt>GetValue</tt></u></span>===
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
Returns the current value of the component.
|-
| 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''
|}


'''Parameters'''


:''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;" | '''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''
|}




'''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;" | '''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''
|}


===<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;" | '''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''
|}


:[[Variable Types|FLOAT]] ''value''
::A new value for the component.


 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
'''Return value'''
|-
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
:''This call does not return a value''
| 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 171:


==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>Type</u></span>
| colspan="2" | &nbsp;
 
|-
This property is of type ''Fixed list of text'' and can be referenced with the variable name ''nType''.
| width="10%" align="center" | [[File:Fc9-type-12-icon.png]]
 
| width="90%" | Type
''<span style="color:red;">No additional information</span>''
|-
 
| colspan="2" | &nbsp;
 
|-
 
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
<span style="font-weight: normal;"><u>Cell Count</u></span>
| width="90%" | Cell Count
 
|-
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''nCellCount''.
| colspan="2" | &nbsp;
 
|-
''<span style="color:red;">No additional information</span>''
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
 
| width="90%" | Show Decimal Point
 
|-
 
| colspan="2" | &nbsp;
<span style="font-weight: normal;"><u>Show Decimal Point</u></span>
|-
 
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
This property is of type ''True or false'' and can be referenced with the variable name ''bShowDP''.
| width="90%" | Show Leading Zeros
 
|-
''<span style="color:red;">No additional information</span>''
| colspan="2" | &nbsp;
 
|-
 
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
 
| width="90%" | Show Sign
<span style="font-weight: normal;"><u>Show Leading Zeros</u></span>
|-
 
| colspan="2" | &nbsp;
This property is of type ''True or false'' and can be referenced with the variable name ''bShowLeadingZeros''.
|-
 
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
''<span style="color:red;">No additional information</span>''
| width="90%" | Decimal Places
 
|-
 
| colspan="2" | &nbsp;
 
|-
<span style="font-weight: normal;"><u>Show Sign</u></span>
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-conn-icon.png]]
 
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Connections'''  
This property is of type ''True or false'' and can be referenced with the variable name ''bShowSign''.
|-
 
|-
''<span style="color:red;">No additional information</span>''
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-conn-icon.png]]
 
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Simulations'''  
 
|-
 
|}
<span style="font-weight: normal;"><u>Decimal Places</u></span>
 
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''nDecimalPlaces''.
 
''<span style="color:red;">No additional information</span>''

Revision as of 16:52, 16 November 2021

Author Steve Tandy
Version 1.0
Category Indicators


Numeric Indicator component

A 2d numeric indicator component.

Detailed description

No detailed description exists yet for this component

Examples

No additional examples


Downloadable macro reference

GetValue
Returns the current value of the component. 
[[File:]] - Return


SetValue
Sets the component to the specified value. 
[[File:]] - value
A new value for the component. 
- VOID Return


SetValue
Sets the component to the specified value. 
[[File:]] - value
A new value for the component. 
- VOID Return


SetValue
Sets the component to the specified value. 
[[File:]] - value
A new value for the component. 
- VOID Return


RefreshChart
Redraws the chart. 
- VOID Return


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


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



Property reference

Properties
Value
 
Style
 
Type
 
Cell Count
 
Show Decimal Point
 
Show Leading Zeros
 
Show Sign
 
Decimal Places
 
Connections
Simulations
Retrieved from "https://www.flowcode.co.uk/wiki/index.php?title=Component:_Numeric_Indicator_(Indicators)&oldid=25115"