Rotary Gauge Component - Maple Help

# Online Help

###### All Products    Maple    MapleSim

Home : Support : Online Help : Programming : Document Tools : Components : Rotary Gauge Component

DocumentTools[Components]

 RotaryGauge
 generate XML for a RotaryGauge Component

 Calling Sequence RotaryGauge( rng, opts )

Parameters

 rng - (optional) range(realcons); range of position values opts - (optional) ; one or more keyword options as described below

Options

 • action : string; A string which parses to one or more valid statements in 1-D Maple Notation. These statements form the Value Changed Action Component Code that executes when the Rotary Gauge's position is manually adjusted.
 • continuous : truefalse; Indicates whether dragging of the sliding component will result in continuous updates using the action code.
 • enabled : truefalse; Indicates whether the component is enabled. The default is true. If enabled is false then the inserted sliding component is grayed out and interaction with it cannot be initiated.
 • identity : {name,string}; The reference name of the component.
 • majorticks : numeric; The interval between the major tickmarks on the sliding component. The default is .2 times the upper value of rng minus the lower value of rng.
 • minorticks : numeric; The interval between the minor tickmarks on the sliding component. The default is 1/2 majorticks.
 • position : numeric; The initial position of the sliding component. If not specified the value of the left endpoint of the rng argument is used.
 • showlabels : truefalse; Indicates whether values are shown beside tickmarks. The default is true.
 • showticks : truefalse; Indicates whether tickmarks are shown. The default is true.
 • tooltip : string; The text that appears when the mouse pointer hovers over the component.
 • visible : truefalse; Indicates whether the component is visible. The default is true.

Description

 • The RotaryGauge command in the Component Constructors package returns an XML function call which represents a RotaryGauge Component.
 • The generated XML can be used with the results of commands in the Layout Constructors package to create an entire Worksheet or Document in XML form. Such a representation of a Worksheet or Document can be inserted into the current document using the InsertContent command.

Examples

 > $\mathrm{with}\left(\mathrm{DocumentTools}\right):$
 > $\mathrm{with}\left(\mathrm{DocumentTools}:-\mathrm{Components}\right):$
 > $\mathrm{with}\left(\mathrm{DocumentTools}:-\mathrm{Layout}\right):$

Executing the RotaryGauge command produces a function call.

 > $S≔\mathrm{RotaryGauge}\left(\mathrm{identity}="RotaryGauge0"\right)$
 ${S}{≔}{\mathrm{_XML_EC-Rotary-Gauge}}{}\left({"id"}{=}{"RotaryGauge0"}{,}{"lower-bound"}{=}{"0"}{,}{"upper-bound"}{=}{"100"}{,}{"control-position"}{=}{"0"}{,}{"major-tick-spacing"}{=}{"20"}{,}{"minor-ticks"}{=}{"10"}{,}{"show-labels"}{=}{"true"}{,}{"show-ticks"}{=}{"true"}{,}{"continuous-update"}{=}{"true"}{,}{"inputenabled"}{=}{"true"}{,}{"visible"}{=}{"true"}\right)$ (1)

By using commands from the DocumentTools:-Layout package a nested function call can be produced which represents a worksheet.

 > $\mathrm{xml}≔\mathrm{Worksheet}\left(\mathrm{Group}\left(\mathrm{Input}\left(\mathrm{Textfield}\left(S\right)\right)\right)\right):$

That XML representation of a worksheet can be inserted directly.

 > $\mathrm{InsertContent}\left(\mathrm{xml}\right):$

 > $\mathrm{codestring}≔"\ns := true;\n\nt := false;"$
 ${\mathrm{codestring}}{≔}{"s := true; t := false;"}$ (2)
 > $S≔\mathrm{RotaryGauge}\left(0...11.0,\mathrm{identity}="RotaryGauge0",\mathrm{tooltip}="My example RotaryGauge",\mathrm{showlabels},\mathrm{position}=6.45,\mathrm{width}=90,\mathrm{height}=90,\mathrm{action}=\mathrm{codestring}\right):$
 > $\mathrm{xml}≔\mathrm{Worksheet}\left(\mathrm{Group}\left(\mathrm{Input}\left(\mathrm{Textfield}\left(S\right)\right)\right)\right):$

The previous example's call to the InsertContent command inserted a component with identity "RotaryGauge0", which still exists in this worksheet. Inserting additional content whose input contains another component with that same identity "RotaryGauge0" incurs a substitution of the input identity in order to avoid a conflict with the identity of the existing component.

The return value of the following call to InsertContent is a table which can be used to reference the substituted identity of the inserted component.

 > $\mathrm{lookup}≔\mathrm{InsertContent}\left(\mathrm{xml},\mathrm{output}=\mathrm{table}\right)$
 ${\mathrm{lookup}}{≔}{table}{}\left(\left[{"RotaryGauge0"}{=}{"RotaryGauge1"}\right]\right)$ (3)

 > $\mathrm{lookup}\left["RotaryGauge0"\right]$
 ${"RotaryGauge1"}$ (4)
 > $\mathrm{GetProperty}\left(\mathrm{lookup}\left["RotaryGauge0"\right],\mathrm{value}\right)$
 ${6.45}$ (5)
 > 

Compatibility

 • The DocumentTools:-Components:-RotaryGauge command was introduced in Maple 2015.
 • For more information on Maple 2015 changes, see Updates in Maple 2015.

 See Also