Difference between revisions of "Component: GLCD Graph Creator XY (Graphical Library)"
From Flowcode Help
Jump to navigationJump to searchLine 17: | Line 17: | ||
==Component Source Code== | ==Component Source Code== | ||
− | Please click here | + | Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_Lib_GLCD_GraphXY.fcfx FC_Comp_Source_Lib_GLCD_GraphXY.fcfx] |
==Detailed description== | ==Detailed description== | ||
+ | |||
+ | |||
Line 26: | Line 28: | ||
==Examples== | ==Examples== | ||
+ | |||
+ | |||
Line 32: | Line 36: | ||
==Macro reference== | ==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;" | '''AddPoint''' | ||
+ | |- | ||
+ | | colspan="2" | Adds a new data point to the graph. | ||
+ | |- | ||
+ | |- | ||
+ | | width="10%" align="center" | [[File:Fc9-s16-icon.png]] - INT | ||
+ | | width="90%" | X | ||
+ | |- | ||
+ | | colspan="2" | X Data Value to plot | ||
+ | |- | ||
+ | | width="10%" align="center" | [[File:Fc9-s16-icon.png]] - INT | ||
+ | | width="90%" | Y | ||
+ | |- | ||
+ | | colspan="2" | Y Data Value to plot | ||
+ | |- | ||
+ | | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE | ||
+ | | width="90%" | Index | ||
+ | |- | ||
+ | | colspan="2" | Plot Index: Range 0-7 | ||
+ | |- | ||
+ | | 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;" | '''Initialise''' | ||
+ | |- | ||
+ | | colspan="2" | Initialises the graph object on the GLCD to the specified dimensions. | ||
+ | |- | ||
+ | |- | ||
+ | | 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'' | ||
+ | |} | ||
+ | |||
+ | |||
+ | |||
+ | |||
+ | ==Property reference== | ||
+ | |||
+ | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
+ | |- | ||
+ | | width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]] | ||
+ | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties''' | ||
+ | |- | ||
+ | |- | ||
+ | | width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]] | ||
+ | | width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Display Properties | ||
+ | |- | ||
+ | |- | ||
+ | | width="10%" align="center" | [[File:Fc9-type-16-icon.png]] | ||
+ | | width="90%" | LinkTo | ||
+ | |- | ||
+ | | colspan="2" | | ||
+ | |- | ||
+ | | width="10%" align="center" | [[File:Fc9-type-7-icon.png]] | ||
+ | | width="90%" | ColourDisplay | ||
+ | |- | ||
+ | | colspan="2" | Automatically detects if the graphical LCD object is colour or monochrome | ||
+ | |- | ||
+ | | width="10%" align="center" | [[File:Fc9-type-21-icon.png]] | ||
+ | | width="90%" | X Coord | ||
+ | |- | ||
+ | | colspan="2" | X coordinate for the top left of the graph container rectangle | ||
+ | |- | ||
+ | | width="10%" align="center" | [[File:Fc9-type-21-icon.png]] | ||
+ | | width="90%" | Y Coord | ||
+ | |- | ||
+ | | colspan="2" | Y coordinate for the top left of the graph container rectangle | ||
+ | |- | ||
+ | | width="10%" align="center" | [[File:Fc9-type-21-icon.png]] | ||
+ | | width="90%" | Width | ||
+ | |- | ||
+ | | colspan="2" | Horizontal size of the graph in pixels | ||
+ | |- | ||
+ | | width="10%" align="center" | [[File:Fc9-type-21-icon.png]] | ||
+ | | width="90%" | Height | ||
+ | |- | ||
+ | | colspan="2" | Vertical size of the graph in pixels | ||
+ | |- | ||
+ | | width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]] | ||
+ | | width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Graph Properties | ||
+ | |- | ||
+ | |- | ||
+ | | width="10%" align="center" | [[File:Fc9-type-16-icon.png]] | ||
+ | | width="90%" | Number Of Plots | ||
+ | |- | ||
+ | | colspan="2" | Determines the number of plots that can be displayed simultaneously on the graph. Monochrome displays can only support a single plot. | ||
+ | |- | ||
+ | | width="10%" align="center" | [[File:Fc9-type-21-icon.png]] | ||
+ | | width="90%" | Number Of Points | ||
+ | |- | ||
+ | | colspan="2" | 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%" | Graph Style | ||
+ | |- | ||
+ | | colspan="2" | Controls the graph draw style. Point - Draws a single point Line - Draws a line from the last point to the new point | ||
+ | |- | ||
+ | | width="10%" align="center" | [[File:Fc9-type-14-icon.png]] | ||
+ | | width="90%" | Min X Value | ||
+ | |- | ||
+ | | colspan="2" | Value to represent the bottom Y axis on the graph | ||
+ | |- | ||
+ | | width="10%" align="center" | [[File:Fc9-type-14-icon.png]] | ||
+ | | width="90%" | Max X Value | ||
+ | |- | ||
+ | | colspan="2" | Value to represent the top Y axis on the graph | ||
+ | |- | ||
+ | | width="10%" align="center" | [[File:Fc9-type-14-icon.png]] | ||
+ | | width="90%" | Min Y Value | ||
+ | |- | ||
+ | | colspan="2" | Value to represent the bottom Y axis on the graph | ||
+ | |- | ||
+ | | width="10%" align="center" | [[File:Fc9-type-14-icon.png]] | ||
+ | | width="90%" | Max Y Value | ||
+ | |- | ||
+ | | colspan="2" | Value to represent the top Y axis on the graph | ||
+ | |- | ||
+ | | width="10%" align="center" | [[File:Fc9-type-7-icon.png]] | ||
+ | | width="90%" | Show Border | ||
+ | |- | ||
+ | | colspan="2" | Decides if a border for the graph is generated | ||
+ | |- | ||
+ | | width="10%" align="center" | [[File:Fc9-type-16-icon.png]] | ||
+ | | width="90%" | Show Grid | ||
+ | |- | ||
+ | | colspan="2" | Decides if a X or Y grid is shown for the graph | ||
+ | |- | ||
+ | | width="10%" align="center" | [[File:Fc9-type-21-icon.png]] | ||
+ | | width="90%" | X Subdivisions | ||
+ | |- | ||
+ | | colspan="2" | Number of horizontal divisions to draw | ||
+ | |- | ||
+ | | width="10%" align="center" | [[File:Fc9-type-21-icon.png]] | ||
+ | | width="90%" | Y Subdivisions | ||
+ | |- | ||
+ | | colspan="2" | Number of vertical divisions to draw | ||
+ | |- | ||
+ | | width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]] | ||
+ | | width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Theme | ||
+ | |- | ||
+ | |- | ||
+ | | width="10%" align="center" | [[File:Fc9-type-1-icon.png]] | ||
+ | | width="90%" | Background Colour | ||
+ | |- | ||
+ | | colspan="2" | Determines the graph background colour. | ||
+ | |- | ||
+ | | width="10%" align="center" | [[File:Fc9-type-1-icon.png]] | ||
+ | | width="90%" | Grid Colour | ||
+ | |- | ||
+ | | colspan="2" | Determines the graph grid colour. | ||
+ | |- | ||
+ | | width="10%" align="center" | [[File:Fc9-type-1-icon.png]] | ||
+ | | width="90%" | Plot 0 Colour | ||
+ | |- | ||
+ | | colspan="2" | Determines the graph plot colour. | ||
+ | |}==Macro reference== | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" |
Revision as of 15:15, 20 January 2023
Author | Matrix TSL |
Version | 1.2 |
Category | Graphical Library |
Contents
GLCD Graph Creator XY component
A component to simplify the process of drawing XY graphs and charts using a graphical LCD.
Component Source Code
Please click here to view the component source code (Beta): FC_Comp_Source_Lib_GLCD_GraphXY.fcfx
Detailed description
No detailed description exists yet for this component
Examples
No additional examples
Macro reference
AddPoint | |
Adds a new data point to the graph. | |
- INT | X |
X Data Value to plot | |
- INT | Y |
Y Data Value to plot | |
- BYTE | Index |
Plot Index: Range 0-7 | |
- VOID | Return |
Initialise | |
Initialises the graph object on the GLCD to the specified dimensions. | |
- VOID | Return |
Property reference
==Macro reference==
AddPoint | |
Adds a new data point to the graph. | |
- INT | X |
X Data Value to plot | |
- INT | Y |
Y Data Value to plot | |
- BYTE | Index |
Plot Index: Range 0-7 | |
- VOID | Return |
Initialise | |
Initialises the graph object on the GLCD to the specified dimensions. | |
- VOID | Return |