Rotary Gauge Component - Maple Help
For the best experience, we recommend viewing online help using Google Chrome or Microsoft Edge.
Our website is currently undergoing maintenance, which may result in occasional errors while browsing. We apologize for any inconvenience this may cause and are working swiftly to restore full functionality. Thank you for your patience.

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

Parameters

Options

Description

Examples

Compatibility

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

withDocumentTools:

withDocumentTools:-Components:

withDocumentTools:-Layout:

Executing the RotaryGauge command produces a function call.

SRotaryGaugeidentity=RotaryGauge0

S_XML_EC-Rotary-Gaugeid=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

(1)

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

xmlWorksheetGroupInputTextfieldS:

That XML representation of a worksheet can be inserted directly.

InsertContentxml:

codestring\ns := true;\n\nt := false;

codestring s := true; t := false;

(2)

SRotaryGauge0...11.0,identity=RotaryGauge0,tooltip=My example RotaryGauge,showlabels,position=6.45,width=90,height=90,action=codestring:

xmlWorksheetGroupInputTextfieldS:

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.

lookupInsertContentxml,output=table

lookuptableRotaryGauge0=RotaryGauge1

(3)

lookupRotaryGauge0

RotaryGauge1

(4)

GetPropertylookupRotaryGauge0,value

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

Component Code

Component Constructors

DocumentTools

Embedded Components

XMLTools