Rotary Gauge Component
insert a rotary gauge in a worksheet or document
Description
Image of the Components Palette Item
Image of an Inserted Rotary Gauge
Rotary Gauge Properties
Rotary Gauge Component Example
The rotary gauge component performs an action or a series of actions to communicate with other embedded components when adjusting the needle in the gauge, although assigning an action to a component is not required.
To perform an action when the needle is adjusted, click the rotary gauge, and then from the Rotary Gauge context panel, select Edit Value Changed Code to open the Code Editor dialog for the rotary gauge. Enter the commands you want to perform in the Code Editor dialog.
You need to specify one or more embedded components that will display the output when adjusting the needle in the gauge. For more information, see the Rotary Gauge Component Example on this page.
The rotary gauge component is customized by setting options in the RotaryGauge Properties. To view the Rotary Gauge context panel, select the rotary gauge. Actions are associated with components using routines in the DocumentTools package.
The Name property is used to reference the rotary gauge when using the routines from the DocumentTools package.
The Show Axis Label and Show Axis Tick Marks properties displays an axis label and axis tick marks on the rotary gauge respectively when selected.
The Continuous Update on Drag property performs a continuous action on one or more components when selected. The Maple commands in the Edit Value Changed Code property must be programmed as such to perform this continuous action.
The following table describes the control and use of the rotary gauge component options.
An x in the Get column indicates that the option can be read, that is, retrieved by using the DocumentTools[GetProperty] tool.
An x in the Set column indicates that the option can be written, that is, set by using the DocumentTools[SetProperty] tool.
Option
Get
Set
Option Type
continuousupdate
x
true or false
enabled
lower
integer or floating-point number
majorticks
positive integer or positive floating-point number
minorticks
pixelheight
positive integer
pixelwidth
showlabels
showticks
tooltip
string
type
upper
value
visible
Indicates whether the component should update continuously during drag operations. By default, the value is false.
Whether the component is enabled. If enabled is set to true, the thumb can be moved with the mouse. By default, the value is false.
The lower bound on the rotary gauge. By default, the value is 0.
The interval between the major ticks on the rotary gauge. By default, the value is 20.
The interval between the minor ticks on the rotary gauge. By default, the value is 10.
The height of the rotary gauge image in pixels. By default, the value is 128.
The width of the rotary gauge image in pixels. By default, the value is 128.
Indicates if range values are shown. By default, the value is true.
Indicates if tick marks are shown. By default, the value is true.
The text that appears when the user hovers the mouse over the component.
The type of the component. This returns "RotaryGauge".
The upper bound on the rotary gauge. By default, the value is 100.
The current position of the rotary gauge marker. By default, the value is 0.
Specifies if the rotary gauge is visible. By default, the value is true.
Note: To interact with the examples provided below, open this help page as a worksheet and then execute the worksheet.
This example alters the position of a Rotary Gauge component by moving Meter and Slider components.
To insert the components:
Type Time(h), Distance(km), and Velocity(km/h) on three separate lines.
Insert a Meter beside Time, a Slider beside Distance, and a Rotary Gauge beside Velocity using the Components palette. For information on displaying the Maple palettes, see the Show Palettes help page.
To set up the range and action for the Meter:
Click the Meter component to display the context panel.
Set the following values in the Meter context panel:
Value at Lowest Position=1
Value at Highest Position=12
Current Position=4
Spacing of Major Tick Marks=2
Spacing of Minor Tick Marks=1
Select Enable Input
Select Continuous Update on Drag
Select Edit Value Changed Code.
This launches the Code Editor dialog.
Before the end use; statement in the dialog, enter the following commands:
t:=GetProperty("Meter0", value);
d:=GetProperty("Slider0", value);
v:=d/t;
SetProperty("RotaryGauge0", value, v);
Note: Ensure the names of the components are correct (that is, that they match the Name fields for their components).
Click or from the File menu, select Save Code to accept all changes.
From the File menu, select Close Code Editor.
To change the appearance and action of the Slider:
Click on the Slider component to display the context panel.
Set the following values in the Slider context panel:
Value at Highest Position=1500
Current Position =200
Spacing of Major Tick Marks=750
Spacing of Minor Tick Marks=50
Select Show Axis Labels
Click on the Slider component, and then select Edit Value Changed Code.
To change the appearance of the Rotary Gauge:
Click on the Rotary Gauge component to open the context panel.
Set the following values in the RotaryGauge Properties dialog:
Value at Highest Position=500
Spacing of Major Tick Marks=100
Move the needles on the time or distance components and the Rotary Gauge representing velocity will respond.
Time(h)
Distance(km)
Velocity(km/h)
with(DocumentTools):
You can verify the syntax of the embedded component action by executing the command in the worksheet.
t := GetProperty("Meter0", value);
d := GetProperty("Slider0", value);
v := d/t;
t ≔ 5
d ≔ 543
v ≔ 5435
See Also
DocumentTools
DocumentTools[GetProperty]
DocumentTools[SetProperty]
EmbeddedComponents
Download Help Document
