Difference between revisions of "Component: Graph Plotter (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
 
| Matrix TSL
 
| Matrix TSL
 
|-
 
|-
−
| width="20%" style="color: gray;" | Version
+
| width="20%" style="color:gray;" | Version
−
| 1.0 (Release)
+
| 1.0
 
|-
 
|-
−
| width="20%" style="color: gray;" | Category
+
| width="20%" style="color:gray;" | Category
 
| Indicators
 
| Indicators
 
|}
 
|}
  
  
−
 
+
==Graph Plotter component==
−
==[[File:Component Icon 4861b972_b20b_479a_9620_fb7ab23e66c3.png|Image]] Graph Plotter component==
 
 
A simple component to allow a number of values to be plotted onto a panel primitive.
 
A simple component to allow a number of values to be plotted onto a panel primitive.
  
−
==Examples==
+
==Component Source Code==
−
''<span style="color:red;">No additional examples</span>''
 
  
 +
Please click here for the component source code: [https://www.flowcode.co.uk/wikicopy/componentsource/FC_Comp_Source_GraphPlotter.fcfx FC_Comp_Source_GraphPlotter.fcfx]
  
−
==Downloadable macro reference==
+
==Detailed description==
  
−
===<span style="font-weight: normal;"><u><tt>AddPoint</tt></u></span>===
+
''No detailed description exists yet for this component''
−
Adds a new data point to the graph.
 
  
−
'''Parameters'''
+
==Examples==
  
−
:[[Variable Types|UINT]] ''Data''
 
−
::Data Value to plot
 
  
−
:[[Variable Types|BYTE]] ''Index''
+
''<span style="color:red;">No additional examples</span>''
−
::Plot Index: Range 0-7
 
  
  
−
'''Return value'''
+
==Downloadable macro reference==
  
−
:''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;" | '''AddPoint'''
 +
|-
 +
| colspan="2" | Adds a new data point to the graph.&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" | Data
 +
|-
 +
| colspan="2" | Data Value to plot&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Index
 +
|-
 +
| colspan="2" | Plot Index: Range 0-7&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>Initialise</tt></u></span>===
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
−
Initialises the graph object on the GLCD to the specified dimensions.
+
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Initialise'''
 +
|-
 +
| colspan="2" | Initialises the graph object on the GLCD to the specified dimensions. X, Y coordinates dictate the top left corner of the graph. Width, Height measurements dictate the size of the graph.&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" | X
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" | Y
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" | Width
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" | Height
 +
|-
 +
| colspan="2" | &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''
 +
|}
  
−
X, Y coordinates dictate the top left corner of the graph.
 
  
−
Width, Height measurements dictate the size of the graph.
 
−
 
−
'''Parameters'''
 
−
 
−
:[[Variable Types|UINT]] ''X''
 
−
 
−
:[[Variable Types|UINT]] ''Y''
 
−
 
−
:[[Variable Types|UINT]] ''Width''
 
−
 
−
:[[Variable Types|UINT]] ''Height''
 
−
 
−
 
−
'''Return value'''
 
−
 
−
:''This call does not return a value''
 
−
 
−
 
−
 
−
==Simulation macro reference==
 
−
 
−
''This component does not contain any simulation macros''
 
  
  
 
==Property reference==
 
==Property reference==
−
<span style="font-weight: normal;"><u>Number Of Plots</u></span>
 
  
−
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''NumPlots''.
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
−
 
+
|-
−
Determines the number of plots that can be displayed simultaneously on the graph.
+
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
−
 
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''  
−
Monochrome displays can only support a single plot.
+
|-
−
 
+
|-
−
<span style="font-weight: normal;"><u>Number Of Points</u></span>
+
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
−
 
+
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Graph Properties
−
This property is of type ''Unsigned integer'' and can be referenced with the variable name ''NumPoints''.
+
|-
−
 
+
|-
−
Number of data points the graph can store, multiplied by the number of plots.
+
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
−
 
+
| width="90%" | Number Of Plots
−
<span style="font-weight: normal;"><u>Graph Style</u></span>
+
|-
−
 
+
| colspan="2" | Determines the number of plots that can be displayed simultaneously on the graph. Monochrome displays can only support a single plot.&nbsp;
−
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''GraphStyle''.
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
−
''<span style="color:red;">No additional information</span>''
+
| width="90%" | Number Of Points
−
 
+
|-
−
 
+
| colspan="2" | Number of data points the graph can store, multiplied by the number of plots.&nbsp;
−
 
+
|-
−
<span style="font-weight: normal;"><u>Min Value</u></span>
+
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
−
 
+
| width="90%" | Graph Style
−
This property is of type ''Signed integer'' and can be referenced with the variable name ''MinVal''.
+
|-
−
 
+
| colspan="2" | &nbsp;
−
''<span style="color:red;">No additional information</span>''
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
−
 
+
| width="90%" | Min Value
−
 
+
|-
−
<span style="font-weight: normal;"><u>Max Value</u></span>
+
| colspan="2" | &nbsp;
−
 
+
|-
−
This property is of type ''Signed integer'' and can be referenced with the variable name ''MaxVal''.
+
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
−
 
+
| width="90%" | Max Value
−
''<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>Show Grid</u></span>
+
| width="90%" | Show Grid
−
 
+
|-
−
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''ShowGrid''.
+
| colspan="2" | &nbsp;
−
 
+
|-
−
''<span style="color:red;">No additional information</span>''
+
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
−
 
+
| width="90%" | X Subdivisions
−
 
+
|-
−
 
+
| colspan="2" | &nbsp;
−
<span style="font-weight: normal;"><u>Pixel Width</u></span>
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
−
This property is of type ''Unsigned integer'' and can be referenced with the variable name ''PixelWidth''.
+
| width="90%" | Y Subdivisions
−
 
+
|-
−
''<span style="color:red;">No additional information</span>''
+
| colspan="2" | &nbsp;
−
 
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
−
 
+
| width="90%" | Pixel Width
−
<span style="font-weight: normal;"><u>Pixel Height</u></span>
+
|-
−
 
+
| colspan="2" | &nbsp;
−
This property is of type ''Unsigned integer'' and can be referenced with the variable name ''PixelHeight''.
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
−
''<span style="color:red;">No additional information</span>''
+
| width="90%" | Pixel Height
−
 
+
|-
−
 
+
| colspan="2" | &nbsp;
−
 
+
|-
−
<span style="font-weight: normal;"><u>Background Colour</u></span>
+
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
−
 
+
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Theme
−
This property is of type ''Color picker'' and can be referenced with the variable name ''BgCol''.
+
|-
−
 
+
|-
−
Determines the graph background colour.
+
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
−
 
+
| width="90%" | Background Colour
−
<span style="font-weight: normal;"><u>Plot 1 Colour</u></span>
+
|-
−
 
+
| colspan="2" | Determines the graph background colour. &nbsp;
−
This property is of type ''Color picker'' and can be referenced with the variable name ''P1Col''.
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
−
Determines the graph plot colour.
+
| width="90%" | Grid Colour
−
 
+
|-
−
<span style="font-weight: normal;"><u>Plot 2 Colour</u></span>
+
| colspan="2" | Determines the graph grid colour. &nbsp;
−
 
+
|-
−
This property is of type ''Color picker'' and can be referenced with the variable name ''P2Col''.
+
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
−
 
+
| width="90%" | Plot 1 Colour
−
Determines the graph plot colour.
+
|-
 +
| colspan="2" | Determines the graph plot colour. &nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
 +
| width="90%" | Plot 2 Colour
 +
|-
 +
| colspan="2" | Determines the graph plot colour. &nbsp;
 +
|}

Revision as of 17:47, 9 November 2022

Author Matrix TSL
Version 1.0
Category Indicators


Graph Plotter component

A simple component to allow a number of values to be plotted onto a panel primitive.

Component Source Code

Please click here for the component source code: FC_Comp_Source_GraphPlotter.fcfx

Detailed description

No detailed description exists yet for this component

Examples

No additional examples


Downloadable macro reference

Fc9-comp-macro.png AddPoint
Adds a new data point to the graph. 
Fc9-u16-icon.png - UINT Data
Data Value to plot 
Fc9-u8-icon.png - BYTE Index
Plot Index: Range 0-7 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png Initialise
Initialises the graph object on the GLCD to the specified dimensions. X, Y coordinates dictate the top left corner of the graph. Width, Height measurements dictate the size of the graph. 
Fc9-u16-icon.png - UINT X
 
Fc9-u16-icon.png - UINT Y
 
Fc9-u16-icon.png - UINT Width
 
Fc9-u16-icon.png - UINT Height
 
Fc9-void-icon.png - VOID Return



Property reference

Fc9-prop-icon.png Properties
Fc9-conn-icon.png Graph Properties
Fc9-type-16-icon.png Number Of Plots
Determines the number of plots that can be displayed simultaneously on the graph. Monochrome displays can only support a single plot. 
Fc9-type-21-icon.png Number Of Points
Number of data points the graph can store, multiplied by the number of plots. 
Fc9-type-16-icon.png Graph Style
 
Fc9-type-14-icon.png Min Value
 
Fc9-type-14-icon.png Max Value
 
Fc9-type-16-icon.png Show Grid
 
Fc9-type-21-icon.png X Subdivisions
 
Fc9-type-21-icon.png Y Subdivisions
 
Fc9-type-21-icon.png Pixel Width
 
Fc9-type-21-icon.png Pixel Height
 
Fc9-conn-icon.png Theme
Fc9-type-1-icon.png Background Colour
Determines the graph background colour.  
Fc9-type-1-icon.png Grid Colour
Determines the graph grid colour.  
Fc9-type-1-icon.png Plot 1 Colour
Determines the graph plot colour.  
Fc9-type-1-icon.png Plot 2 Colour
Determines the graph plot colour.  
Retrieved from "https://www.flowcode.co.uk/wiki/index.php?title=Component:_Graph_Plotter_(Indicators)&oldid=28794"