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

From Flowcode Help
Jump to navigationJump to search
(XML import)
 
 
(7 intermediate revisions by 2 users not shown)
Line 1: Line 1:
−
 
+
{| style="width:50%"
−
 
 
−
{| width="50%"
 
 
|-
 
|-
−
| width="20%" style="color: gray;" | Author
+
| width="20%" style="color:gray;" | Author
 
| Matrix Ltd
 
| Matrix Ltd
 
|-
 
|-
−
| width="20%" style="color: gray;" | Version
+
| width="20%" style="color:gray;" | Version
−
| 1.2 (Release)
+
| 1.2
 
|-
 
|-
−
| width="20%" style="color: gray;" | Category
+
| width="20%" style="color:gray;" | Category
 
| Advanced Shapes
 
| 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.
  
−
==[[File:Component Icon 34671299_61e7_40d8_aac1_e33c93759d73.png|Image]] Scale Linear Template component==
+
==Component Pack==
−
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.
 
  
−
This component can be used as a base to create ''child'' components
+
FREE
  
−
The following components all inherit the traits of Scale Linear Template:
+
==Detailed description==
  
−
{| class="wikitable" width="50%"
 
−
|+|-
 
−
|[[File:Component Icon c7af6f97_a9d6_45d0_a7d2_48d85dbef664.png|Image]] Dash Scale Horizontal
 
−
|Horizontal based slider with a user defined scale, typically used on in SCADA based solution
 
−
|-
 
−
|[[File:Component Icon f51b5e55_6a64_49ad_b79d_2b57db0cd54b.png|Image]] Dash Scale Vertical
 
−
|Vertical based slider with a user defined scale, typically used on in SCADA based solution
 
−
|}
 
  
−
==Examples==
 
−
''<span style="color:red;">No additional examples</span>''
 
  
  
−
==Downloadable macro reference==
 
  
−
''This component does not contain any downloadable macros''
+
''No detailed description exists yet for this component''
  
−
==Simulation macro reference==
+
==Examples==
  
−
===<span style="font-weight: normal;"><u><tt>GetValue</tt></u></span>===
 
−
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.
 
  
−
'''Parameters'''
 
  
−
:''This macro has no parameters''
 
  
 +
''<span style="color:red;">No additional examples</span>''
  
−
'''Return value'''
+
==Downloadable macro reference==
  
−
:[[Variable Types|FLOAT]]
+
{| 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;" | '''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;
 +
|-
 +
|-
 +
| 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''
 +
|}
  
  
−
===<span style="font-weight: normal;"><u><tt>SetValue</tt></u></span>===
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
−
Set the value for the scale.  If a pointer object is defined, it will move to point at the new value.
+
|-
 +
| 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="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''
 +
|}
  
−
'''Parameters'''
 
  
−
:[[Variable Types|FLOAT]] ''Value''
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
−
::Value to set - will be constrained to the minumum-maximum range.
+
|-
 +
| 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;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
 +
| width="90%" | Text
 +
|-
 +
| colspan="2" | New text to set.&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''
 +
|}
  
  
−
'''Return value'''
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
−
 
+
|-
−
:''This call does not return a value''
+
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
−
 
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetRange'''
−
 
+
|-
−
===<span style="font-weight: normal;"><u><tt>SetLabel</tt></u></span>===
+
| colspan="2" | Set new maximum and minimum values for the scale.&nbsp;
−
Set the text of the component's label.
+
|-
−
 
+
|-
−
'''Parameters'''
+
| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
−
 
+
| width="90%" | Minimum
−
:[[Variable Types|STRING]] ''Text''
+
|-
−
::New text to set.
+
| colspan="2" | The minimum value of the scale (Bottom of the component)&nbsp;
−
 
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
−
'''Return value'''
+
| width="90%" | Maximum
−
 
+
|-
−
:''This call does not return a value''
+
| colspan="2" | The maximum value of the scale (Top of the component)&nbsp;
−
 
+
|-
−
 
+
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
−
===<span style="font-weight: normal;"><u><tt>SetRange</tt></u></span>===
+
| width="90%" style="border-top: 2px solid #000;" | ''Return''
−
Set new maximum and minimum values for the scale.
+
|}
−
 
 
−
'''Parameters'''
 
−
 
 
−
:[[Variable Types|FLOAT]] ''Minimum''
 
−
::The minimum value of the scale (Bottom of the component)
 
−
 
 
−
:[[Variable Types|FLOAT]] ''Maximum''
 
−
::The maximum value of the scale (Top of the component)
 
−
 
 
−
 
 
−
'''Return value'''
 
−
 
 
−
:''This call does not return a value''
 
  
  
Line 106: Line 112:
  
 
==Property reference==
 
==Property reference==
−
<span style="font-weight: normal;"><u>Pointer</u></span>
 
  
−
This property is of type ''Panel object'' and can be referenced with the variable name ''target_object''.
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
−
 
+
|-
−
Sets an object to act as the pointer for the scale.
+
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
−
 
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''
−
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.
+
| width="10%" align="center" | [[File:Fc9-type-17-icon.png]]
−
 
+
| width="90%" | Pointer
−
<span style="font-weight: normal;"><u>Track</u></span>
+
|-
−
 
+
| colspan="2" | 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.&nbsp;
−
This property is of type ''Panel object'' and can be referenced with the variable name ''track_object''.
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-17-icon.png]]
−
An object to represent a 'track' parallel to the scale upon which the moving part travels.
+
| width="90%" | Track
−
 
+
|-
−
If the scale is resized or moved, the 'track' object will also be scaled or moved.
+
| colspan="2" | 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.&nbsp;
−
 
+
|-
−
For example, the 'track' object could be a simple black rectangle to represent the 'slot' in which
+
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
−
 
+
| width="90%" | Orientation
−
a slider control moves.
+
|-
−
 
+
| colspan="2" | Whether the scale and/or motion should be along the X-axis (horizontal) or Y-axis (vertical)&nbsp;
−
<span style="font-weight: normal;"><u>Orientation</u></span>
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
−
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''orientation''.
+
| width="90%" | Function
−
 
+
|-
−
Whether the scale and/or motion should be along the X-axis (horizontal) or Y-axis (vertical)
+
| 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;
−
 
+
|-
−
<span style="font-weight: normal;"><u>Function</u></span>
+
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
−
 
+
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Style
−
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''is_slider''.
+
|-
−
 
+
|-
−
Set the mode of the component...
+
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
−
 
+
| width="90%" | Resolution
−
Display - the pointer object moves only when a value is set using the 'SetValue' macro.
+
|-
−
 
+
| colspan="2" | Determines the amount of detail in the scale graphics - larger values will require more memory and/or loading time etc.&nbsp;
−
Control - the pointer can be moved using the mouse to set a new value, which can then be read using the
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
−
'GetValue' macro.
+
| width="90%" | BG Color
−
 
+
|-
−
<span style="font-weight: normal;"><u>Resolution</u></span>
+
| colspan="2" | Colour of the background object.&nbsp;
−
 
+
|-
−
This property is of type ''Signed integer'' and can be referenced with the variable name ''resolution''.
+
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
−
 
+
| width="90%" | Positive Color
−
Determines the amount of detail in the scale graphics - larger values will require more memory
+
|-
−
 
+
| colspan="2" | Markings colour for positive scale values.&nbsp;
−
and/or loading time etc.
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
−
<span style="font-weight: normal;"><u>BG Color</u></span>
+
| width="90%" | Negative Color
−
 
+
|-
−
This property is of type ''Color picker with transparency'' and can be referenced with the variable name ''bg_color''.
+
| colspan="2" | Markings colour for negative values.&nbsp;
−
 
+
|-
−
Colour of the background object.
+
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
−
 
+
| width="90%" | Label Color
−
<span style="font-weight: normal;"><u>Positive Color</u></span>
+
|-
−
 
+
| colspan="2" | Color for the text label.&nbsp;
−
This property is of type ''Color picker'' and can be referenced with the variable name ''ink_color''.
+
|-
−
 
+
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
−
Markings colour for positive scale values.
+
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Line
−
 
+
|-
−
<span style="font-weight: normal;"><u>Negative Color</u></span>
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
−
This property is of type ''Color picker'' and can be referenced with the variable name ''neg_color''.
+
| width="90%" | Offset %
−
 
+
|-
−
Markings colour for negative values.
+
| colspan="2" | Distance of the main line from the left or bottom of the component. % of component size.&nbsp;
−
 
+
|-
−
<span style="font-weight: normal;"><u>Label Color</u></span>
+
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
−
 
+
| width="90%" | Start %
−
This property is of type ''Color picker'' and can be referenced with the variable name ''label_color''.
+
|-
−
 
+
| colspan="2" | Start position of the scale from the left/bottom of the component.  % of component size.&nbsp;
−
Color for the text label.
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
−
<span style="font-weight: normal;"><u>Offset %</u></span>
+
| width="90%" | End %
−
 
+
|-
−
This property is of type ''Signed integer'' and can be referenced with the variable name ''line_offset''.
+
| colspan="2" | End position of the scale from the left/bottom of the component.  % of component size.&nbsp;
−
 
+
|-
−
Distance of the main line from the left or bottom of the component. % of component size.
+
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
−
 
+
| width="90%" | Thickness
−
<span style="font-weight: normal;"><u>Start %</u></span>
+
|-
−
 
+
| colspan="2" | Thickness of the main scale line.&nbsp;
−
This property is of type ''Signed integer'' and can be referenced with the variable name ''line_start''.
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
−
Start position of the scale from the left/bottom of the component.  % of component size.
+
| width="90%" | Show
−
 
+
|-
−
<span style="font-weight: normal;"><u>End %</u></span>
+
| colspan="2" | Whether to show or hide the main scale line.&nbsp;
−
 
+
|-
−
This property is of type ''Signed integer'' and can be referenced with the variable name ''line_end''.
+
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
−
 
+
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Marks
−
End position of the scale from the left/bottom of the component.  % of component size.
+
|-
−
 
+
|-
−
<span style="font-weight: normal;"><u>Thickness</u></span>
+
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
−
 
+
| width="90%" | Divisions
−
This property is of type ''Floating point'' and can be referenced with the variable name ''line_thick''.
+
|-
−
 
+
| colspan="2" | Number of major divisions of the scale - these can be numbered.&nbsp;
−
Thickness of the main scale line.
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
−
<span style="font-weight: normal;"><u>Show</u></span>
+
| width="90%" | Offset %
−
 
+
|-
−
This property is of type ''True or false'' and can be referenced with the variable name ''show_line''.
+
| colspan="2" | Position of the division lines across the scale - % of component size,.&nbsp;
−
 
+
|-
−
Whether to show or hide the main scale line.
+
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
−
 
+
| width="90%" | Thickness
−
<span style="font-weight: normal;"><u>Divisions</u></span>
+
|-
−
 
+
| colspan="2" | Thickness of the division lines.&nbsp;
−
This property is of type ''Signed integer'' and can be referenced with the variable name ''marks_count''.
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
−
Number of major divisions of the scale - these can be numbered.
+
| width="90%" | Subdivisions
−
 
+
|-
−
<span style="font-weight: normal;"><u>Offset %</u></span>
+
| colspan="2" | Number of smaller divsions between the numbered ones.  Set to zero if not required.&nbsp;
−
 
+
|-
−
This property is of type ''Signed integer'' and can be referenced with the variable name ''marks_offset''.
+
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
−
 
+
| width="90%" | Subs Offset
−
Position of the division lines across the scale - % of component size,.
+
|-
−
 
+
| colspan="2" | Position of the sub-division line ends.  % of width across the component.&nbsp;
−
<span style="font-weight: normal;"><u>Thickness</u></span>
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
−
This property is of type ''Floating point'' and can be referenced with the variable name ''divs_thick''.
+
| width="90%" | Subs Thickness
−
 
+
|-
−
Thickness of the division lines.
+
| colspan="2" | Thickness of the sub-division lines..&nbsp;
−
 
+
|-
−
<span style="font-weight: normal;"><u>Subdivisions</u></span>
+
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
−
 
+
| width="90%" | Show
−
This property is of type ''Signed integer'' and can be referenced with the variable name ''marks_subdiv''.
+
|-
−
 
+
| colspan="2" | Whether to show or hide the divisions and sub-divisions.&nbsp;
−
Number of smaller divsions between the numbered ones.  Set to zero if not required.
+
|-
−
 
+
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
−
<span style="font-weight: normal;"><u>Subs Offset</u></span>
+
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Numbers
−
 
+
|-
−
This property is of type ''Signed integer'' and can be referenced with the variable name ''subdiv_offset''.
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
−
Position of the sub-division line ends.  % of width across the component.
+
| width="90%" | Maximum
−
 
+
|-
−
<span style="font-weight: normal;"><u>Subs Thickness</u></span>
+
| colspan="2" | Maximum number to show on the scale.&nbsp;
−
 
+
|-
−
This property is of type ''Floating point'' and can be referenced with the variable name ''subs_thick''.
+
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
−
 
+
| width="90%" | Minimum
−
Thickness of the sub-division lines..
+
|-
−
 
+
| colspan="2" | Minimum number to show on the scale.&nbsp;
−
<span style="font-weight: normal;"><u>Show</u></span>
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
−
This property is of type ''True or false'' and can be referenced with the variable name ''show_marks''.
+
| width="90%" | Decimals
−
 
+
|-
−
Whether to show or hide the divisions and sub-divisions.
+
| colspan="2" | Number of decimal places to show on the numbers.&nbsp;
−
 
+
|-
−
<span style="font-weight: normal;"><u>Maximum</u></span>
+
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
−
 
+
| width="90%" | Offset %
−
This property is of type ''Floating point'' and can be referenced with the variable name ''val_max''.
+
|-
−
 
+
| colspan="2" | Distance acrross the scale width to show the numbers.  % of component size.&nbsp;
−
Maximum number to show on the scale.
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
−
<span style="font-weight: normal;"><u>Minimum</u></span>
+
| width="90%" | Text Size %
−
 
+
|-
−
This property is of type ''Floating point'' and can be referenced with the variable name ''val_min''.
+
| colspan="2" | Text height of the scale numbers. % of component size.&nbsp;
−
 
+
|-
−
Minimum number to show on the scale.
+
| width="10%" align="center" | [[File:Fc9-type-3-icon.png]]
−
 
+
| width="90%" | Font
−
<span style="font-weight: normal;"><u>Decimals</u></span>
+
|-
−
 
+
| colspan="2" | Font for the scale numbers.&nbsp;
−
This property is of type ''Signed integer'' and can be referenced with the variable name ''dec_places''.
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
−
Number of decimal places to show on the numbers.
+
| width="90%" | Show
−
 
+
|-
−
<span style="font-weight: normal;"><u>Offset %</u></span>
+
| colspan="2" | Whether to show or hide the scale numbers.&nbsp;
−
 
+
|-
−
This property is of type ''Signed integer'' and can be referenced with the variable name ''num_offset''.
+
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
−
 
+
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Label
−
Distance acrross the scale width to show the numbers. % of component size.
+
|-
−
 
+
|-
−
<span style="font-weight: normal;"><u>Text Size %</u></span>
+
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
−
 
+
| width="90%" | Text
−
This property is of type ''Signed integer'' and can be referenced with the variable name ''num_size''.
+
|-
−
 
+
| colspan="2" | Text label for the component to aid identification.&nbsp;
−
Text height of the scale numbers.  % of component size.
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
−
<span style="font-weight: normal;"><u>Font</u></span>
+
| width="90%" | Offset X %
−
 
+
|-
−
This property is of type ''Font picker'' and can be referenced with the variable name ''num_font''.
+
| colspan="2" | X - position of the label.  % of Width.&nbsp;
−
 
+
|-
−
Font for the scale numbers.
+
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
−
 
+
| width="90%" | Offset Y %
−
<span style="font-weight: normal;"><u>Show</u></span>
+
|-
−
 
+
| colspan="2" | Y position of label.  % of height.&nbsp;
−
This property is of type ''True or false'' and can be referenced with the variable name ''show_numbers''.
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
−
Whether to show or hide the scale numbers.
+
| width="90%" | Text Size %
−
 
+
|-
−
<span style="font-weight: normal;"><u>Text</u></span>
+
| colspan="2" | Text size of label.  % of component size.&nbsp;
−
 
+
|-
−
This property is of type ''Line of text'' and can be referenced with the variable name ''label_text''.
+
| width="10%" align="center" | [[File:Fc9-type-3-icon.png]]
−
 
+
| width="90%" | Font
−
Text label for the component to aid identification.
+
|-
−
 
+
| colspan="2" | Font for the component label.&nbsp;
−
<span style="font-weight: normal;"><u>Offset X %</u></span>
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
−
This property is of type ''Signed integer'' and can be referenced with the variable name ''label_X''.
+
| width="90%" | Show
−
 
+
|-
−
X - position of the label.  % of Width.
+
| colspan="2" | Whether to show or hide the text label.&nbsp;
−
 
+
|}
−
<span style="font-weight: normal;"><u>Offset Y %</u></span>
 
−
 
 
−
This property is of type ''Signed integer'' and can be referenced with the variable name ''label_Y''.
 
−
 
 
−
Y position of label.  % of height.
 
−
 
 
−
<span style="font-weight: normal;"><u>Text Size %</u></span>
 
−
 
 
−
This property is of type ''Signed integer'' and can be referenced with the variable name ''label_size''.
 
−
 
 
−
Text size of label.  % of component size.
 
−
 
 
−
<span style="font-weight: normal;"><u>Font</u></span>
 
−
 
 
−
This property is of type ''Font picker'' and can be referenced with the variable name ''label_font''.
 
−
 
 
−
Font for the component label.
 
−
 
 
−
<span style="font-weight: normal;"><u>Show</u></span>
 
−
 
 
−
This property is of type ''True or false'' and can be referenced with the variable name ''show_label''.
 
−
 
 
−
Whether to show or hide the text label.
 

Latest revision as of 17:22, 9 November 2022

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 Pack

FREE

Detailed description

No detailed description exists yet for this component

Examples

No additional examples

Downloadable macro reference

Fc9-comp-macro.png 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. 
Fc9-f32-icon.png - FLOAT Return


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


Fc9-comp-macro.png SetLabel
Set the text of the component's label. 
Fc9-string-icon.png - STRING Text
New text to set. 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png SetRange
Set new maximum and minimum values for the scale. 
Fc9-f32-icon.png - FLOAT Minimum
The minimum value of the scale (Bottom of the component) 
Fc9-f32-icon.png - FLOAT Maximum
The maximum value of the scale (Top of the component) 
Fc9-void-icon.png - VOID Return



Property reference

Fc9-prop-icon.png Properties
Fc9-type-17-icon.png 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. 
Fc9-type-17-icon.png 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. 
Fc9-type-16-icon.png Orientation
Whether the scale and/or motion should be along the X-axis (horizontal) or Y-axis (vertical) 
Fc9-type-16-icon.png 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. 
Fc9-conn-icon.png Style
Fc9-type-14-icon.png Resolution
Determines the amount of detail in the scale graphics - larger values will require more memory and/or loading time etc. 
Fc9-type-2-icon.png BG Color
Colour of the background object. 
Fc9-type-1-icon.png Positive Color
Markings colour for positive scale values. 
Fc9-type-1-icon.png Negative Color
Markings colour for negative values. 
Fc9-type-1-icon.png Label Color
Color for the text label. 
Fc9-conn-icon.png Line
Fc9-type-14-icon.png Offset %
Distance of the main line from the left or bottom of the component. % of component size. 
Fc9-type-14-icon.png Start %
Start position of the scale from the left/bottom of the component. % of component size. 
Fc9-type-14-icon.png End %
End position of the scale from the left/bottom of the component. % of component size. 
Fc9-type-15-icon.png Thickness
Thickness of the main scale line. 
Fc9-type-7-icon.png Show
Whether to show or hide the main scale line. 
Fc9-conn-icon.png Marks
Fc9-type-14-icon.png Divisions
Number of major divisions of the scale - these can be numbered. 
Fc9-type-14-icon.png Offset %
Position of the division lines across the scale - % of component size,. 
Fc9-type-15-icon.png Thickness
Thickness of the division lines. 
Fc9-type-14-icon.png Subdivisions
Number of smaller divsions between the numbered ones. Set to zero if not required. 
Fc9-type-14-icon.png Subs Offset
Position of the sub-division line ends. % of width across the component. 
Fc9-type-15-icon.png Subs Thickness
Thickness of the sub-division lines.. 
Fc9-type-7-icon.png Show
Whether to show or hide the divisions and sub-divisions. 
Fc9-conn-icon.png Numbers
Fc9-type-15-icon.png Maximum
Maximum number to show on the scale. 
Fc9-type-15-icon.png Minimum
Minimum number to show on the scale. 
Fc9-type-14-icon.png Decimals
Number of decimal places to show on the numbers. 
Fc9-type-14-icon.png Offset %
Distance acrross the scale width to show the numbers. % of component size. 
Fc9-type-14-icon.png Text Size %
Text height of the scale numbers. % of component size. 
Fc9-type-3-icon.png Font
Font for the scale numbers. 
Fc9-type-7-icon.png Show
Whether to show or hide the scale numbers. 
Fc9-conn-icon.png Label
Fc9-type-10-icon.png Text
Text label for the component to aid identification. 
Fc9-type-14-icon.png Offset X %
X - position of the label. % of Width. 
Fc9-type-14-icon.png Offset Y %
Y position of label. % of height. 
Fc9-type-14-icon.png Text Size %
Text size of label. % of component size. 
Fc9-type-3-icon.png Font
Font for the component label. 
Fc9-type-7-icon.png Show
Whether to show or hide the text label. 
Retrieved from "https://www.flowcode.co.uk/wikiv9/index.php?title=Component:_Scale_Linear_Template_(Advanced_Shapes)&oldid=28751"