Difference between revisions of "Component: Base2dObject (Development)"

From Flowcode Help
Jump to navigationJump to search
(Created page with "{| style="width:50%" |- | width="20%" style="color:gray;" | Author | Steve Tandy |- | width="20%" style="color:gray;" | Version | 1.0 |- | width="20%" style="color:gra...")
 
 
(3 intermediate revisions by the same user not shown)
Line 14: Line 14:
 
==Base2dObject component==
 
==Base2dObject component==
  
 +
 +
==Component Pack==
 +
 +
FREE
  
 
==Detailed description==
 
==Detailed description==
 +
 +
 +
 +
 +
 +
 +
 +
  
 
''No detailed description exists yet for this component''
 
''No detailed description exists yet for this component''
Line 21: Line 33:
 
==Examples==
 
==Examples==
  
−
''<span style="color:red;">No additional examples</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:]] -
 
−
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
−
|}
 
  
  
−
{| 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''
 
−
|}
 
  
  
−
{| 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;" | '''SetMode'''
 
−
|-
 
−
| colspan="2" | Select the mode of operation&nbsp;
 
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:]] -
 
−
| width="90%" | bUseArrays
 
−
|-
 
−
| colspan="2" | True if data points are added to a hidden buffer; False if data is drawn directly onto 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="color:red;">No additional examples</span>''
 +
 +
==Downloadable macro reference==
  
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
|-
 
|-
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
−
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ClearData'''
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetValue'''
 
|-
 
|-
−
| colspan="2" | Removes all datapoints from the chart.&nbsp;
+
| colspan="2" | Returns the current value of the component.&nbsp;
 
|-
 
|-
 
|-
 
|-
−
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
+
| 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''
 
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
|}
 
|}
Line 95: Line 66:
 
|-
 
|-
 
|-
 
|-
−
| width="10%" align="center" | [[File:]] -  
+
| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
 
| width="90%" | value
 
| width="90%" | value
 
|-
 
|-
 
| colspan="2" | A new value for the component.&nbsp;
 
| 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''
 
−
|}
 
−
 
−
 
−
{| 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''
 
−
|}
 
−
 
−
 
−
{| 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''
 
−
|}
 
−
 
−
 
−
{| 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="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID

Latest revision as of 16:16, 7 January 2022

Author Steve Tandy
Version 1.0
Category Development


Base2dObject 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 Connections
Fc9-conn-icon.png Simulations
Retrieved from "https://www.flowcode.co.uk/wiki/index.php?title=Component:_Base2dObject_(Development)&oldid=27440"