Differences

This shows you the differences between two versions of the page.

Link to this comparison view

web:slider [2020/04/09 04:23] (current)
agcyphers created
Line 1: Line 1:
 +==== See Also ====
 +This class has no related objects.
  
 +==== Enumerations ====
 +^ Name      ^ Values       ^
 +| HandleStyles | Round |
 +| ::: | Square |
 +| ::: | Triangle |
 +| TooltipPositions | TopLeft |
 +| ::: | BottomRight |
 +| TooltipVisibilities | Show |
 +| ::: | Hide |
 +| ::: | Always |
 +
 +==== Constants ====
 +^ Name      ^ Type     ^ Value       ^
 +This class exposes no constants.
 +
 +==== Events ====
 +^ Definition      ^ Description       ^
 +| Change | This event is raised when the user changes the value of the slider by interacting with it. |
 +
 +==== Methods ====
 +^ Definition      ^ Parameters   ^ Return Value  ^ Description       ^
 +| AddRangeStyle | startValue as Double | None | Adds a WebStyle to the specified portion of the slider's background. |
 +| ::: | endValue as Double | ::: | ::: |
 +| ::: | theStyle as WebStyle | ::: | ::: |
 +| AddTick | tickPosition as Integer | None | Adds a tick position with label to the slider. |
 +| ::: | tickLabel as String | ::: | ::: |
 +| RemoveAllRangeStyles | None | None | Removes all previously added ranged WebStyles. |
 +| RemoveAllTicks | None | None | Removes all previously added tick positions. |
 +| RemoveRangeStyle | rangeStart as Double | None | Removes the Range Style whose start position matches the supplied value. |
 +| RemoveTicks | tickPosition as Integer | None | Removes the tick and label whose start position matches the supplied value. |
 +
 +==== Properties ====
 +^ Name      ^ Type       ^ Default Value       ^ Description       ^
 +| AcceptFocus | Boolean | False | When True, the slider will accept focus by either user tabbing or click. |
 +| HandleStyle | HandleStyles | HandleStyles.Round | The design used for the slider's handles. |
 +| LogarithmicScale | Boolean | False | If True, uses a logarithmic scale for ticks that is calculated based on the difference between min to max. If False, uses a linear scale at regular intervals. |
 +| MaxValue | Double | 100 | The maximum selectable value of the slider. |
 +| MinValue | Double | 0 | The minimum selectable value of the slider. |
 +| Precision | Integer | 0 | The number of digits displayed after the decimal point. |
 +| Range | Boolean | False | When True, the slider uses two knobs to allow the selection of a range of values rather than a singular value. |
 +| RealtimeChange | Boolean | True | When False, the value will only be updated when the handle(s) is released. |
 +| Reversed | Boolean | False | When True, the lower end of the value range is to the left. |
 +| StepValue | Integer | 10 | The size of steps when clicking the slider track. |
 +| StyleHandle | WebStyle | Nil | WebStyle applied to handles. |
 +| StyleSelection | WebStyle | Nil | WebStyle applied to the area of the current value. |
 +| StyleTickLabel | WebStyle | Nil | WebStyle applied to ticks. |
 +| TicksSnapRadius | Double | 0 | Snapping radius of handles to ticks. |
 +| TooltipPosition | TooltipPositions | TopLeft | Location of the value tooltip relative to the handle. |
 +| TooltipVisibility | TooltipVisibilities | Show | Whether to show the tooltip on drag, hide the tooltip, or always show the tooltip. |
 +| Value | Double | 0 | Current value, or low value when Ranged = True. |
 +| ValueHigh | Double | 0 | Current high value when Ranged = True. |
 +
 +==== Examples ====
 +This class currently has no examples.
 +
 +==== Notes ====
 +This class currently has no notes.