Jump to content

Component: Scale Linear Template (Advanced Shapes): Difference between revisions

From Flowcode Help

SteveT (talk | contribs)

4 user groups
6,422 edits
Created page with "{| style="width:50%" |- | width="20%" style="color:gray;" | Author | Matrix Ltd |- | width="20%" style="color:gray;" | Version | 1.2 |- | width="20%" style="color:gray..."
 
m Text replacement - "style="background-color:#EAE1EA;"" to "class="mtx-class-propfolder""
 
(14 intermediate revisions by 2 users not shown)
Line 17: Line 17:
==Component Source Code==
==Component Source Code==


Please click here for the component source code: [https://www.flowcode.co.uk/wikicopy/componentsource/FC_Comp_Source_Scale_Linear.fcfx FC_Comp_Source_Scale_Linear.fcfx]
Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_Scale_Linear.fcfx FC_Comp_Source_Scale_Linear.fcfx]
 
Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_Scale_Linear.fcfx FC_Comp_Source_Scale_Linear.fcfx]


==Detailed description==
==Detailed description==


''No detailed description exists yet for this component''
''No detailed description exists yet for this component''


==Examples==
==Examples==


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


==Downloadable macro reference==


{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
 
 
 
 
 
 
 
 
==Macro reference==
 
===GetValue===
{| class="mtx-class-macrotable wikitable"
|-
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetValue'''
| width="90%" class="mtx-class-macrohead" | '''GetValue'''
|-
|-
| colspan="2" | Get the current value from the scale. Will be either the most recent value set by "SetValue", or, if set to "Control" mode, the latest mouse clicked value.&nbsp;
| colspan="2" | Get the current value from the scale. Will be either the most recent value set by "SetValue", or, if set to "Control" mode, the latest mouse clicked value.&nbsp;
Line 42: Line 75:




{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
===SetLabel===
|-
{| class="mtx-class-macrotable wikitable"
| 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" | Set the value for the scale.  If a pointer object is defined, it will move to point at the new value.&nbsp;
|-
|-
|-
| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" | Value
| width="90%" class="mtx-class-macrohead" | '''SetLabel'''
|-
| colspan="2" | Value to set - will be constrained to the minumum-maximum range.&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;" | '''SetLabel'''
|-
|-
| colspan="2" | Set the text of the component's label.&nbsp;
| colspan="2" | Set the text of the component's label.&nbsp;
Line 78: Line 94:




{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
===SetRange===
{| class="mtx-class-macrotable wikitable"
|-
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetRange'''
| width="90%" class="mtx-class-macrohead" | '''SetRange'''
|-
|-
| colspan="2" | Set new maximum and minimum values for the scale.&nbsp;
| colspan="2" | Set new maximum and minimum values for the scale.&nbsp;
Line 101: Line 118:




===SetValue===
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''SetValue'''
|-
| colspan="2" | Set the value for the scale.  If a pointer object is defined, it will move to point at the new value.&nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
| width="90%" | Value
|-
| colspan="2" | Value to set - will be constrained to the minumum-maximum range.&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''
|}




==Property reference==
==Property reference==


{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
{| class="mtx-class-macrotable wikitable"
|-
|-
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-prop-icon.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''  
| width="90%" class="mtx-class-macrohead" | '''Properties'''  
|-
|-
|-
|-
Line 131: Line 165:
| colspan="2" | Set the mode of the component... Display - the pointer object moves only when a value is set using the 'SetValue' macro. Control - the pointer can be moved using the mouse to set a new value, which can then be read using the 'GetValue' macro.&nbsp;
| colspan="2" | Set the mode of the component... Display - the pointer object moves only when a value is set using the 'SetValue' macro. Control - the pointer can be moved using the mouse to set a new value, which can then be read using the 'GetValue' macro.&nbsp;
|-
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Style
| width="90%" class="mtx-class-propfolder" | Style
|-
|-
|-
|-
Line 160: Line 194:
| colspan="2" | Color for the text label.&nbsp;
| colspan="2" | Color for the text label.&nbsp;
|-
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Line
| width="90%" class="mtx-class-propfolder" | Line
|-
|-
|-
|-
Line 189: Line 223:
| colspan="2" | Whether to show or hide the main scale line.&nbsp;
| colspan="2" | Whether to show or hide the main scale line.&nbsp;
|-
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Marks
| width="90%" class="mtx-class-propfolder" | Marks
|-
|-
|-
|-
Line 228: Line 262:
| colspan="2" | Whether to show or hide the divisions and sub-divisions.&nbsp;
| colspan="2" | Whether to show or hide the divisions and sub-divisions.&nbsp;
|-
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Numbers
| width="90%" class="mtx-class-propfolder" | Numbers
|-
|-
|-
|-
Line 267: Line 301:
| colspan="2" | Whether to show or hide the scale numbers.&nbsp;
| colspan="2" | Whether to show or hide the scale numbers.&nbsp;
|-
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Label
| width="90%" class="mtx-class-propfolder" | Label
|-
|-
|-
|-

Latest revision as of 14:37, 13 July 2026

Author Matrix Ltd
Version 1.2
Category Advanced Shapes


Scale Linear Template component

A base component for drawing scales on horizontal or vertical strips. Can be used to simplify the building of rulers, meters and slider controls. Mouse handling is built in for easy construction of interactive controls.

Component Source Code

Please click here to download the component source project: FC_Comp_Source_Scale_Linear.fcfx

Please click here to view the component source code (Beta): FC_Comp_Source_Scale_Linear.fcfx

Detailed description

No detailed description exists yet for this component

Examples

No additional examples






Macro reference

GetValue

GetValue
Get the current value from the scale. Will be either the most recent value set by "SetValue", or, if set to "Control" mode, the latest mouse clicked value. 
- FLOAT Return


SetLabel

SetLabel
Set the text of the component's label. 
- STRING Text
New text to set. 
- VOID Return


SetRange

SetRange
Set new maximum and minimum values for the scale. 
- FLOAT Minimum
The minimum value of the scale (Bottom of the component) 
- FLOAT Maximum
The maximum value of the scale (Top of the component) 
- VOID Return


SetValue

SetValue
Set the value for the scale. If a pointer object is defined, it will move to point at the new value. 
- FLOAT Value
Value to set - will be constrained to the minumum-maximum range. 
- VOID Return


Property reference

Properties
Pointer
Sets an object to act as the pointer for the scale. If in 'Display' mode, the pointer will move to show the incoming "SetValue" numbers. In "Control" mode, it will act as an object for setting the value using mouse clicks/drags. 
Track
An object to represent a 'track' parallel to the scale upon which the moving part travels. If the scale is resized or moved, the 'track' object will also be scaled or moved. For example, the 'track' object could be a simple black rectangle to represent the 'slot' in which a slider control moves. 
Orientation
Whether the scale and/or motion should be along the X-axis (horizontal) or Y-axis (vertical) 
Function
Set the mode of the component... Display - the pointer object moves only when a value is set using the 'SetValue' macro. Control - the pointer can be moved using the mouse to set a new value, which can then be read using the 'GetValue' macro. 
Style
Resolution
Determines the amount of detail in the scale graphics - larger values will require more memory and/or loading time etc. 
BG Color
Colour of the background object. 
Positive Color
Markings colour for positive scale values. 
Negative Color
Markings colour for negative values. 
Label Color
Color for the text label. 
Line
Offset %
Distance of the main line from the left or bottom of the component. % of component size. 
Start %
Start position of the scale from the left/bottom of the component.  % of component size. 
End %
End position of the scale from the left/bottom of the component.  % of component size. 
Thickness
Thickness of the main scale line. 
Show
Whether to show or hide the main scale line. 
Marks
Divisions
Number of major divisions of the scale - these can be numbered. 
Offset %
Position of the division lines across the scale - % of component size,. 
Thickness
Thickness of the division lines. 
Subdivisions
Number of smaller divsions between the numbered ones. Set to zero if not required. 
Subs Offset
Position of the sub-division line ends.  % of width across the component. 
Subs Thickness
Thickness of the sub-division lines.. 
Show
Whether to show or hide the divisions and sub-divisions. 
Numbers
Maximum
Maximum number to show on the scale. 
Minimum
Minimum number to show on the scale. 
Decimals
Number of decimal places to show on the numbers. 
Offset %
Distance acrross the scale width to show the numbers.  % of component size. 
Text Size %
Text height of the scale numbers.  % of component size. 
Font
Font for the scale numbers. 
Show
Whether to show or hide the scale numbers. 
Label
Text
Text label for the component to aid identification. 
Offset X %
X - position of the label.  % of Width. 
Offset Y %
Y position of label.  % of height. 
Text Size %
Text size of label.  % of component size. 
Font
Font for the component label. 
Show
Whether to show or hide the text label. 
Retrieved from "https://www.flowcode.co.uk/wiki/index.php?title=Component:_Scale_Linear_Template_(Advanced_Shapes)&oldid=48275"