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

From Flowcode Help
Jump to navigationJump to search
Line 16: Line 16:
  
 
==Detailed description==
 
==Detailed description==
 +
 +
  
  
Line 22: Line 24:
  
 
==Examples==
 
==Examples==
 +
 +
  
  
Line 258: Line 262:
 
|-
 
|-
 
| colspan="2" | The value of the data point 
 
| colspan="2" | The value of the data point 
|-
 
| 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;" | '''GetList'''
 
|-
 
| colspan="2" | Returns CHANNEL or PRESCALE list from the FCD and updates the internal property  
 
|-
 
|-
 
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
 
| width="90%" | Name
 
|-
 
| colspan="2" |  
 
|-
 
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-string-icon.png]] - STRING
 
| 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;" | '''InitRXConfig'''
 
|-
 
| colspan="2" | Initialization setting for RX Buffer Config 
 
|-
 
|-
 
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 
| width="90%" | Buffer
 
|-
 
| colspan="2" | Buffer Number (0 or 1) 
 
|-
 
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 
| width="90%" | Value
 
|-
 
| colspan="2" | Config data byte 
 
|-
 
| 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;" | '''Uninit'''
 
|-
 
| colspan="2" | Uninitialises the CAN, freeing its connections for general use  
 
|-
 
|-
 
| 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;" | '''GetList'''
 
|-
 
| colspan="2" | Get the Filter List of the Named Property 
 
|-
 
|-
 
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
 
| width="90%" | Name
 
|-
 
| colspan="2" |  
 
|-
 
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-string-icon.png]] - STRING
 
| 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;" | '''GetRxIdent'''
 
|-
 
| colspan="2" | Generic function to get the received message Identifier.   
 
|-
 
|-
 
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 
| width="90%" | buffer
 
|-
 
| colspan="2" |  
 
|-
 
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u32-icon.png]] - ULONG
 
| 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;" | '''SetRxFilterStd'''
 
|-
 
| colspan="2" | Sets the 16-bit filter as a bit-mask of the standard ID for received messages The messages are accepted if (StdID & Mask) == Filter   
 
|-
 
|-
 
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 
| width="90%" | Filter
 
|-
 
| colspan="2" | Filter number 
 
|-
 
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 
| width="90%" | Hi
 
|-
 
| colspan="2" | The high byte (bits 8-15) of the ID 
 
|-
 
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 
| width="90%" | Lo
 
|-
 
| colspan="2" | The low byte (bits 0-7) of the ID 
 
|-
 
| 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;" | '''SetRxFilterExd'''
 
|-
 
| colspan="2" | Sets the 32-bit filter as a bit-mask of the extended ID for received messages The messages are accepted if (ExtID & Mask) == Filter  
 
|-
 
|-
 
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 
| width="90%" | Filter
 
|-
 
| colspan="2" | Send filter: 0  to 3 
 
|-
 
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 
| width="90%" | ID3
 
|-
 
| colspan="2" | The high byte (bits 24-31) of the ID 
 
|-
 
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 
| width="90%" | ID2
 
|-
 
| colspan="2" | The mid-high byte (bits 16-23) of the ID 
 
|-
 
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 
| width="90%" | ID1
 
|-
 
| colspan="2" | The mid-low byte (bits 8-15) of the ID 
 
|-
 
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 
| width="90%" | ID0
 
|-
 
| colspan="2" | The low byte (bits 0-7) of the ID 
 
 
|-
 
|-
 
| 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:02, 17 November 2021

Author Steve Tandy
Version 1.1
Category Development


Base2dChart component

A base component for creating 2d charts.

Detailed description

No detailed description exists yet for this component

Examples

No additional examples

Downloadable macro reference

Fc9-comp-macro.png AddDataXYY1
Adds a data point for a ternary chart (3 axes) to the specified series. 
Fc9-u8-icon.png - BYTE Series
Which series to add to (1-8) 
[[File:]] - xValue
The value on the first axis 
[[File:]] - yValue
The value on the second axis 
[[File:]] - zValue
The value on the third axis 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png AddData
Adds a data point (y-value only) to the specified series. 
Fc9-u8-icon.png - BYTE Series
Which series to add to (1-8) 
[[File:]] - Value
The data point value 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png AddDataXY
Adds a data point (x and y values) to the specified series. 
Fc9-u8-icon.png - BYTE Series
Which series to add to (1-8) 
[[File:]] - xValue
The x coordinate for the data point 
[[File:]] - yValue
The y coordinate for the data point 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png AddCatData
Adds a data point (y-value only) to the specified series. 
Fc9-u8-icon.png - BYTE Series
Which series to add to (1-8) 
Fc9-string-icon.png - STRING Category
 
[[File:]] - Value
The data point value 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png SetMode
Select the mode of operation 
[[File:]] - bUseArrays
True if data points are added to a hidden buffer; False if data is drawn directly onto chart. 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png ClearData
Removes all datapoints from the chart. 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png SetValue
Sets the component to the specified value. 
[[File:]] - value
A new value for the component. 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png RefreshChart
Redraws the chart. 
Fc9-void-icon.png - VOID Return


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


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



Property reference

Fc9-prop-icon.png Properties
Fc9-type-11-icon.png Categories
 
Fc9-type-11-icon.png Y Values
 
Fc9-type-11-icon.png X Values
 
Fc9-type-11-icon.png Z Values
 
Fc9-type-10-icon.png Title
 
Fc9-type-12-icon.png Style
 
Fc9-type-12-icon.png Stacking
 
Fc9-type-12-icon.png Fill Gradient
 
Fc9-type-8-icon.png Transparency
 
Fc9-type-7-icon.png Data Between Ticks
 
Fc9-type-10-icon.png Name
 
Fc9-type-7-icon.png Show Grid
 
Fc9-type-7-icon.png Auto-scale
 
Fc9-type-15-icon.png Start
 
Fc9-type-15-icon.png End
 
Fc9-type-7-icon.png Logarithmic
 
Fc9-type-7-icon.png Scalable
 
Fc9-type-10-icon.png Name
 
Fc9-type-7-icon.png Show Grid
 
Fc9-type-7-icon.png Auto-scale
 
Fc9-type-15-icon.png Start
 
Fc9-type-15-icon.png End
 
Fc9-type-7-icon.png Logarithmic
 
Fc9-type-7-icon.png Scalable
 
Fc9-type-10-icon.png Name
 
Fc9-type-7-icon.png Show Grid
 
Fc9-type-7-icon.png Auto-scale
 
Fc9-type-15-icon.png Start
 
Fc9-type-15-icon.png End
 
Fc9-type-7-icon.png Logarithmic
 
Fc9-type-7-icon.png Scalable
 
Fc9-type-7-icon.png Show
 
Fc9-type-7-icon.png Show Category
 
Fc9-type-7-icon.png Show Value
 
Fc9-type-7-icon.png Show Percentage
 
Fc9-type-7-icon.png Show Series
 
Fc9-type-14-icon.png Angle
 
Fc9-type-12-icon.png Position
 
Fc9-type-12-icon.png Position
 
Fc9-type-7-icon.png Draw Border
 
Fc9-type-16-icon.png Select Series
 
Fc9-type-10-icon.png Series Name
 
Fc9-type-7-icon.png Visible
 
Fc9-type-7-icon.png Secondary Axis
 
Fc9-type-12-icon.png Line Style
 
Fc9-type-12-icon.png Line Type
 
Fc9-type-16-icon.png Line Width
 
Fc9-type-7-icon.png Shadow
 
Fc9-type-7-icon.png Fill
 
Fc9-type-7-icon.png Show Marker
 
Fc9-type-12-icon.png Marker Shape
 
Fc9-type-21-icon.png Marker Size
 
Fc9-type-10-icon.png Series Name
 
Fc9-type-7-icon.png Visible
 
Fc9-type-7-icon.png Secondary Axis
 
Fc9-type-12-icon.png Line Style
 
Fc9-type-12-icon.png Line Type
 
Fc9-type-16-icon.png Line Width
 
Fc9-type-7-icon.png Shadow
 
Fc9-type-7-icon.png Fill
 
Fc9-type-7-icon.png Show Marker
 
Fc9-type-12-icon.png Marker Shape
 
Fc9-type-21-icon.png Marker Size
 
Fc9-type-10-icon.png Series Name
 
Fc9-type-7-icon.png Visible
 
Fc9-type-7-icon.png Secondary Axis
 
Fc9-type-12-icon.png Line Style
 
Fc9-type-12-icon.png Line Type
 
Fc9-type-16-icon.png Line Width
 
Fc9-type-7-icon.png Shadow
 
Fc9-type-7-icon.png Fill
 
Fc9-type-7-icon.png Show Marker
 
Fc9-type-12-icon.png Marker Shape
 
Fc9-type-21-icon.png Marker Size
 
Fc9-type-10-icon.png Series Name
 
Fc9-type-7-icon.png Visible
 
Fc9-type-7-icon.png Secondary Axis
 
Fc9-type-12-icon.png Line Style
 
Fc9-type-12-icon.png Line Type
 
Fc9-type-16-icon.png Line Width
 
Fc9-type-7-icon.png Shadow
 
Fc9-type-7-icon.png Fill
 
Fc9-type-7-icon.png Show Marker
 
Fc9-type-12-icon.png Marker Shape
 
Fc9-type-21-icon.png Marker Size
 
Fc9-type-10-icon.png Series Name
 
Fc9-type-7-icon.png Visible
 
Fc9-type-7-icon.png Secondary Axis
 
Fc9-type-12-icon.png Line Style
 
Fc9-type-12-icon.png Line Type
 
Fc9-type-16-icon.png Line Width
 
Fc9-type-7-icon.png Shadow
 
Fc9-type-7-icon.png Fill
 
Fc9-type-7-icon.png Show Marker
 
Fc9-type-12-icon.png Marker Shape
 
Fc9-type-21-icon.png Marker Size
 
Fc9-type-10-icon.png Series Name
 
Fc9-type-7-icon.png Visible
 
Fc9-type-7-icon.png Secondary Axis
 
Fc9-type-12-icon.png Line Style
 
Fc9-type-12-icon.png Line Type
 
Fc9-type-16-icon.png Line Width
 
Fc9-type-7-icon.png Shadow
 
Fc9-type-7-icon.png Fill
 
Fc9-type-7-icon.png Show Marker
 
Fc9-type-12-icon.png Marker Shape
 
Fc9-type-21-icon.png Marker Size
 
Fc9-type-10-icon.png Series Name
 
Fc9-type-7-icon.png Visible
 
Fc9-type-7-icon.png Secondary Axis
 
Fc9-type-12-icon.png Line Style
 
Fc9-type-12-icon.png Line Type
 
Fc9-type-16-icon.png Line Width
 
Fc9-type-7-icon.png Shadow
 
Fc9-type-7-icon.png Fill
 
Fc9-type-7-icon.png Show Marker
 
Fc9-type-12-icon.png Marker Shape
 
Fc9-type-21-icon.png Marker Size
 
Fc9-type-10-icon.png Series Name
 
Fc9-type-7-icon.png Visible
 
Fc9-type-7-icon.png Secondary Axis
 
Fc9-type-12-icon.png Line Style
 
Fc9-type-12-icon.png Line Type
 
Fc9-type-16-icon.png Line Width
 
Fc9-type-7-icon.png Shadow
 
Fc9-type-7-icon.png Fill
 
Fc9-type-7-icon.png Show Marker
 
Fc9-type-12-icon.png Marker Shape
 
Fc9-type-21-icon.png Marker Size
 
Fc9-type-21-icon.png nSeries
 
Fc9-type-15-icon.png dXVal
 
Fc9-type-15-icon.png dYVal
 
Fc9-type-15-icon.png dY1Val
 
Fc9-type-10-icon.png sYCat
 
Fc9-type-7-icon.png bUseArrays
 
Fc9-type-7-icon.png fnAddCatValue
 
Fc9-type-7-icon.png fnClearData
 
Fc9-type-7-icon.png fnAddValueCXYY1
 
Fc9-type-7-icon.png fnAddValueXYY1
 
Fc9-type-7-icon.png fnGetValue
 
Fc9-type-7-icon.png fnGetValueXY
 
Fc9-type-7-icon.png fnRefreshChart
 
Fc9-conn-icon.png Connections
Fc9-conn-icon.png Simulations