Jump to content

Component: Base2dChart (Development): Difference between revisions

From Flowcode Help
No edit summary
No edit summary
Line 17: Line 17:
==Component Source Code==
==Component Source Code==


Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_Base2dChart.fcfx FC_Comp_Source_Base2dChart.fcfx]
Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_temp/Base2dChart.fcfx FC_Comp_Source_temp/Base2dChart.fcfx]


Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_Base2dChart.fcfx FC_Comp_Source_Base2dChart.fcfx]
Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_temp/Base2dChart.fcfx FC_Comp_Source_temp/Base2dChart.fcfx]


==Detailed description==
==Detailed description==
Line 76: Line 76:


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




Line 83: Line 85:
==Macro reference==
==Macro reference==


===AddDataXYY1===
===AddCatData===
{| 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;" | '''AddDataXYY1'''
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''AddCatData'''
|-
|-
| colspan="2" | Adds a data point for a ternary chart (3 axes) to the specified series.&nbsp;
| colspan="2" | Adds a data point (y-value only) to the specified series.&nbsp;
|-
|-
|-
|-
Line 97: Line 99:
| colspan="2" | Which series to add to (1-8)&nbsp;
| colspan="2" | Which series to add to (1-8)&nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
| width="90%" | xValue
| width="90%" | Category
|-
|-
| colspan="2" | The value on the first axis&nbsp;
| colspan="2" | &nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
| width="90%" | yValue
| width="90%" | Value
|-
|-
| colspan="2" | The value on the second axis&nbsp;
| colspan="2" | The data point value&nbsp;
|-
| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
| width="90%" | zValue
|-
| colspan="2" | The value on the third axis&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
Line 141: Line 138:




===GetDataXY===
===AddDataCXYY1===
{| 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;" | '''GetDataXY'''
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''AddDataCXYY1'''
|-
|-
| colspan="2" | Gets a data point from the specified XY reference&nbsp;
| colspan="2" | Adds a data point to a bubble chart.&nbsp;
|-
|-
|-
|-
Line 153: Line 150:
| width="90%" | Series
| width="90%" | Series
|-
|-
| colspan="2" | Which series to read from (1-8)&nbsp;
| 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:Fc9-f32-icon.png]] - FLOAT
| width="90%" | Y
|-
| colspan="2" | Y coordinate&nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-s16-icon.png]] - INT
| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
| width="90%" | X
| width="90%" | X
|-
|-
| colspan="2" | X location of the data (1 - 32767)&nbsp;
| colspan="2" | X coordinate&nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-s16-icon.png]] - INT
| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
| width="90%" | Y
| width="90%" | Value
|-
|-
| colspan="2" | Y location of the data (1 - 255)&nbsp;
| colspan="2" | The value of the data point&nbsp;
|-
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-f32-icon.png]] - FLOAT
| 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''
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}
|}
Line 199: Line 206:




===AddCatData===
===AddDataXYY1===
{| 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;" | '''AddCatData'''
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''AddDataXYY1'''
|-
|-
| colspan="2" | Adds a data point (y-value only) to the specified series.&nbsp;
| colspan="2" | Adds a data point for a ternary chart (3 axes) to the specified series.&nbsp;
|-
|-
|-
|-
Line 213: Line 220:
| colspan="2" | Which series to add to (1-8)&nbsp;
| colspan="2" | Which series to add to (1-8)&nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
| width="90%" | Category
| width="90%" | xValue
|-
|-
| colspan="2" | &nbsp;
| colspan="2" | The value on the first axis&nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
| width="90%" | Value
| width="90%" | yValue
|-
|-
| colspan="2" | The data point value&nbsp;
| colspan="2" | The value on the second axis&nbsp;
|-
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
| width="90%" style="border-top: 2px solid #000;" | ''Return''
| width="90%" | zValue
|}
 
 
===SetMode===
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
|-
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| colspan="2" | The value on the third axis&nbsp;
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetMode'''
|-
| colspan="2" | Select the mode of operation&nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
| 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="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
Line 254: Line 247:
|-
|-
| colspan="2" | Removes all datapoints from the chart.&nbsp;
| colspan="2" | Removes all datapoints from 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''
|}
===RefreshChart===
{| 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;
|-
|-
|-
|-
Line 299: Line 278:




===AddDataCXYY1===
===GetDataXY===
{| 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;" | '''AddDataCXYY1'''
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetDataXY'''
|-
|-
| colspan="2" | Adds a data point to a bubble chart.&nbsp;
| colspan="2" | Gets a data point from the specified XY reference&nbsp;
|-
|-
|-
|-
Line 311: Line 290:
| width="90%" | Series
| width="90%" | Series
|-
|-
| colspan="2" | Which series to add to (1-8)&nbsp;
| colspan="2" | Which series to read from (1-8)&nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
| width="10%" align="center" | [[File:Fc9-s16-icon.png]] - INT
| width="90%" | Category
| width="90%" | X
|-
|-
| colspan="2" | &nbsp;
| colspan="2" | X location of the data (1 - 32767)&nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
| width="10%" align="center" | [[File:Fc9-s16-icon.png]] - INT
| width="90%" | Y
| width="90%" | Y
|-
|-
| colspan="2" | Y coordinate&nbsp;
| colspan="2" | Y location of the data (1 - 255)&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''
|}
 
 
===RefreshChart===
{| 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''
|}
 
 
===SetMode===
{| 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'''
|-
|-
| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
| colspan="2" | Select the mode of operation&nbsp;
| width="90%" | X
|-
|-
| colspan="2" | X coordinate&nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
| width="90%" | Value
| width="90%" | bUseArrays
|-
|-
| colspan="2" | The value of the data point&nbsp;
| 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="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID

Revision as of 11:59, 3 February 2023

Author Steve Tandy
Version 1.1
Category Development


Base2dChart component

A base component for creating 2d charts.

Component Source Code

Please click here to download the component source project: FC_Comp_Source_temp/Base2dChart.fcfx

Please click here to view the component source code (Beta): FC_Comp_Source_temp/Base2dChart.fcfx

Detailed description

No detailed description exists yet for this component

Examples

No additional examples




Macro reference

AddCatData

AddCatData
Adds a data point (y-value only) to the specified series. 
- BYTE Series
Which series to add to (1-8) 
- STRING Category
 
- FLOAT Value
The data point value 
- VOID Return


AddData

AddData
Adds a data point (y-value only) to the specified series. 
- BYTE Series
Which series to add to (1-8) 
- FLOAT Value
The data point value 
- VOID Return


AddDataCXYY1

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


AddDataXY

AddDataXY
Adds a data point (x and y values) to the specified series. 
- BYTE Series
Which series to add to (1-8) 
- FLOAT xValue
The x coordinate for the data point 
- FLOAT yValue
The y coordinate for the data point 
- VOID Return


AddDataXYY1

AddDataXYY1
Adds a data point for a ternary chart (3 axes) to the specified series. 
- BYTE Series
Which series to add to (1-8) 
- FLOAT xValue
The value on the first axis 
- FLOAT yValue
The value on the second axis 
- FLOAT zValue
The value on the third axis 
- VOID Return


ClearData

ClearData
Removes all datapoints from the chart. 
- VOID Return


GetData

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


GetDataXY

GetDataXY
Gets a data point from the specified XY reference 
- BYTE Series
Which series to read from (1-8) 
- INT X
X location of the data (1 - 32767) 
- INT Y
Y location of the data (1 - 255) 
- FLOAT Return


RefreshChart

RefreshChart
Redraws the chart. 
- VOID Return


SetMode

SetMode
Select the mode of operation 
- BOOL bUseArrays
True if data points are added to a hidden buffer; False if data is drawn directly onto chart. 
- VOID Return



Property reference

Properties
Data
Categories
 
Y Values
 
X Values
 
Z Values
 
Appearance
Title
 
Style
 
Stacking
 
Fill Gradient
 
Transparency
 
Data Between Ticks
 
X-axis
Name
 
Show Grid
 
Auto-scale
 
Start
 
End
 
Logarithmic
 
Scalable
 
Y-axis
Name
 
Show Grid
 
Auto-scale
 
Start
 
End
 
Logarithmic
 
Scalable
 
Y-axis (secondary)
Name
 
Show Grid
 
Auto-scale
 
Start
 
End
 
Logarithmic
 
Scalable
 
Data Labels
Show
 
Show Category
 
Show Value
 
Show Percentage
 
Show Series
 
Angle
 
Position
 
Legend
Position
 
Draw Border
 
Select Series
 
Series1
Series Name
 
Visible
 
Secondary Axis
 
Line Style
 
Line Type
 
Line Width
 
Shadow
 
Fill
 
Show Marker
 
Marker Shape
 
Marker Size