Scale class
| VI Server Class Information | |
|---|---|
| Return to VI Server Class Hierarchy | |
| Class Name | Scale class |
| Class ID | 40 |
| Scope | Basic Development Environment |
| Class Inheritance |
|
| Class Children | |
 |
This article is a stub. You can help LabVIEW Wiki by expanding it. Please improve this article if you can. |
The Scale class is a class in the VI Server Class Hierarchy, (see also VI Server).
Properties
Show/Hide Scale Properties Table
| Legend | |
|---|---|
| R/W | Readable/Writable Permissions |
| RTE | Available in the Run-Time Engine |
| Basic Development Environment | |
| VI Scripting | |
| Private | |
| Deprecated | |
| Property ID | Short Name (English) | Description | R/W | RTE | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 632F018 | AutoscalePadding | R/W | X | |||||||||||||||||||||
| 632F001 | DisplayFormat | Specifies the format and precision of the scale. Format can be 0-Decimal, 1-Scientific, 2-Engineering, 3-Binary, 4-Octal, 5-Hexadecimal, 6-Relative Time, 7-Time and Date, 8-SI, or 9-Custom (read-only). Precision is the number of digits after the decimal point.
This property is similar to the options on the Display Format page of the Properties dialog box. |
R/W | X | ||||||||||||||||||||
| 632F002 | Format | Specifies the format of the numeric increments of the scale. This property accepts the following format values: 0-Decimal, 1-Scientific, 2-Engineering, 3-Binary, 4-Octal, 5-Hexadecimal, 6-Relative Time, 7-Time and Date, 8-SI, and 9-Custom (read-only). You cannot wire a value of 9 to this property because the value is read-only. This property returns a value of 9 if the object uses automatic formatting, the format string contains text, or the format string includes more than one format specifier.
If you select floating point representation for the numeric increments, you cannot wire a value of 3, 4, or 5 to this property. Binary, Octal, and Hexadecimal formats are not valid for floating point numbers. If you wire one of these values, this property returns an error. This property is an element of the Display Format property. This property is similar to the options on the Display Format page of the Properties dialog box. |
R/W | X | ||||||||||||||||||||
| 632F003 | Precision | Number of digits after the decimal point. If you wire a value of 9 to the Format property, this property returns an error.
This property is an element of the Display Format property. This property is similar to the Digits option on the Display Format page of the Properties dialog box. |
R/W | X | ||||||||||||||||||||
| 632F00C | Editable | Allows editing of scale values. | R/W | X | ||||||||||||||||||||
| 632F00A | Flipped | If TRUE, reverses the positions of the minimum and maximum values on the scale.
This property is similar to the Inverted option on the Scale page of the Properties dialog box. |
R/W | X | ||||||||||||||||||||
| 632F016 | FormatString | Sets the format string of the scale.
Refer to the valid format specifiers for numeric data types table for information about which format specifiers you can set depending on the data type of the numeric control and the format specifiers syntax elements table for descriptions of the syntax elements. If you want to format a string to display time, enclose the string with %. This property is similar to the Format string option on the Display Format page of the Properties dialog box. |
R/W | X | ||||||||||||||||||||
| 632F00B | MapMode | Scale mapping mode: 0-Linear, 1-Logarithmic.
This property is similar to the Mapping item on the shortcut menu of a scale. |
R/W | X | ||||||||||||||||||||
| 632F015 | Marker | Reference to the scale marker.
You can use this reference with the Text properties. |
R | X | ||||||||||||||||||||
| 632F012 | MarkerColors | Text color and background color of scale marker.
You can set the color of the front panel object by wiring a hexadecimal number with the form RRGGBB or by wiring the color box constant to the property. |
R/W | X | ||||||||||||||||||||
| 632F014 | BGColor | Background color of the scale marker.
You can set the color of the front panel object by wiring a hexadecimal number with the form RRGGBB or by wiring the color box constant to the property. This property is an element of the Marker Colors property. |
R/W | X | ||||||||||||||||||||
| 632F013 | TextColor | Color of the scale marker text.
You can set the color of the front panel object by wiring a hexadecimal number with the form RRGGBB or by wiring the color box constant to the property. This property is similar to the Marker text color option on the Scales page of the Properties dialog box. This property is an element of the Marker Colors property. |
R/W | X | ||||||||||||||||||||
| 632F004 | Range | A scale is a component of many front panel objects in LabVIEW, such as the X and Y scales of graphs and charts. The scale consists of a range of values, specified as a cluster of (Minimum, Maximum, Increment, Minor Increment, and Start). | R/W | X | ||||||||||||||||||||
| 632F007 | Increment | Increment value of scale. Use this property to determine the distance between tick marks.
This property is an element of the Range property. |
R/W | X | ||||||||||||||||||||
| 632F006 | Maximum | Maximum value of scale. Use this property to set the maximum value allowed in the range.
This property is an element of the Range property. This property is similar to the Maximum option on the Scales page of the Properties dialog box. |
R/W | X | ||||||||||||||||||||
| 632F005 | Minimum | Minimum value of scale. Use this property to set the minimum value allowed in the range.
This property is an element of the Range property. This property is similar to the Minimum option on the Scales page of the Properties dialog box. |
R/W | X | ||||||||||||||||||||
| 632F008 | MinorInc | Minor increment value of scale. Use this property to determine the distance between minor tick marks.
This property is an element of the Range property. |
R/W | X | ||||||||||||||||||||
| 632F009 | RngStart | Start value of scale. Use this property to determine the value of the first tick marker after the minimum.
This property is an element of the Range property. |
R/W | X | ||||||||||||||||||||
| 632F000 | Style | Gets or sets the style of the marks on a scale. The values (0-8) for this property correspond with the options on the Style shortcut menu, available by right-clicking a scale on a graph or chart and selecting Style, from top-left (0) to bottom-right (8).
This property is similar to the Style item on the shortcut menu of a scale. The following image shows the Style shortcut menu: Refer to the following table for a description of each value:
|
R/W | X | ||||||||||||||||||||
| 632F017 | TickColors | Gets or sets the tick color and minor tick color of the scale. | R/W | X | ||||||||||||||||||||
| 632F00E | MinorTickColor | Color of the minor tick mark.
You can set the color of the front panel object by wiring a hexadecimal number with the form RRGGBB or by wiring the color box constant to the property. This property is similar to the Minor tick color option on the Scales page of the Properties dialog box. |
R/W | X | ||||||||||||||||||||
| 632F00D | TickColor | Color of the tick mark.
You can set the color of the front panel object by wiring a hexadecimal number with the form RRGGBB or by wiring the color box constant to the property. This property is similar to the Major tick color option on the Scales page of the Properties dialog box. |
R/W | X | ||||||||||||||||||||
| 632F00F | UniformMarker | Determines whether the markers are uniformly spaced.
This property is similar to the Marker Spacing item on the shortcut menu of a scale. |
R/W | X | ||||||||||||||||||||
| 632F010 | Visible | Shows the scale.
This property is similar to the Show scale option on the Scales page of the Properties dialog box. |
R/W | X |
Methods
No Methods for this class.
Events
No Events for this class.
History
 |
History information is needed. What changes have occurred over previous versions? |
| Version | Change(s) |
|---|---|
|
More info to come. |