Version: Unity 6.3 LTS (6000.3)
LanguageEnglish
  • C#

Slider

class in UnityEngine.UIElements

/

Inherits from:UIElements.BaseSlider_1

/

Implemented in:UnityEngine.UIElementsModule

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Description

A slider containing floating point values.

The Slider control is a horizontal or vertical bar with a handle that can be moved to select a value from a range. The range is defined by the lowValue and highValue properties.

The slider manages navigation events in a customized manner. When it detects NavigationMoveEvent. that align with the slider's direction, it adjusts the slider's value. If it detects a NavigationSubmitEvent, it removes the BaseSlider_1.movableUssClassName class from the dragger, causing all Navigation events to revert to their default behavior. A second navigation submit event re-enables the movableUssClassName class on the dragger and restores the previous customized behavior.

For more information and code examples, refer to the UXML element Slider manual page.

Additional resources: MinMaxSlider

Static Properties

Property Description
inputUssClassName USS class name of input elements in elements of this type.
labelUssClassName USS class name of labels in elements of this type.
ussClassName USS class name of elements of this type.

Constructors

Constructor Description
Slider Creates a new instance of a Slider.

Inherited Members

Static Properties

PropertyDescription
alignedFieldUssClassName USS class name of elements that are aligned in a inspector element
labelDraggerVariantUssClassName USS class name of labels in elements of this type, when there is a dragger attached on them.
mixedValueLabelUssClassName USS class name of elements that show mixed values
noLabelVariantUssClassName USS class name of elements of this type, when there is no label.
dragContainerUssClassName USS class name of container elements in elements of this type.
draggerBorderUssClassName USS class name of the dragger border element in elements of this type.
draggerUssClassName USS class name of dragger elements in elements of this type.
fillUssClassName USS class name of fill element in elements of this type.
horizontalVariantUssClassName USS class name of elements of this type, when they are displayed horizontally.
inputUssClassName USS class name of input elements in elements of this type.
labelUssClassName USS class name of labels in elements of this type.
movableUssClassName USS class name on the dragger that indicates it is currently controlled by NavigationMoveEvent. When the slider detects move events aligned with the slider's direction, it adjusts the slider's value. If it detects a navigation submit event, it removes the style, causing all navigation events to revert to their default behavior. A second navigation submit event re-applies the style to the dragger and restores the previous customized behavior.
textFieldClassName USS class name of the text field element in elements of this type.
trackerUssClassName USS class name of tracker elements in elements of this type.
ussClassName USS class name of elements of this type.
verticalVariantUssClassName USS class name of elements of this type, when they are displayed vertically.
disabledUssClassName USS class name of local disabled elements.

Properties

PropertyDescription
label The string representing the label that will appear beside the field. If the string is empty, the label element is removed from the hierarchy. If the string is not empty, the label element is added to the hierarchy.
labelElement This is the Label object that appears beside the input for the field.
mixedValueLabel Read-only label used to give the appearance of editing multiple different values.
rawValue The value of the element.
showMixedValue When set to true, gives the field the appearance of editing multiple different values.
direction This is the actual property to contain the direction of the slider.
fill Enables fill to set the color and shape of a slider.
highValue This is the maximum value that the slider encodes.
inverted This indicates whether or not this slider is inverted. For an inverted horizontal slider, high value is located to the left, low value is located to the right For an inverted vertical slider, high value is located to the bottom, low value is located to the top.
lowValue This is the minimum value that the slider encodes.
pageSize Represents the value that should be applied to the calculated scroll offset while scrolling the slider, such as when clicking within the track or clicking the slider arrows.
range This is the range from the minimum value to the maximum value of the slider.
showInputField The visibility of the optional field inside the slider control.
value The actual value of the slider.
binding Binding object that will be updated.
bindingPath Path of the target property to be bound.
canGrabFocus Whether the element can be focused.
delegatesFocus Whether the element delegates the focus to its children.
focusable Whether an element can potentially receive focus.
focusController Returns the focus controller for this element.
tabIndex An integer used to sort focusable elements in the focus ring. Must be greater than or equal to zero.
childCount Number of child elements in this object's contentContainer.
contentContainer Logical container where child elements are added. If a child is added to this element, the child is added to this element's content container instead.
contentRect The rectangle of the content area of the element, in the local space of the element. (Read Only)
customStyle The custom style properties accessor of a VisualElement (Read Only).
dataSource Assigns a data source to this VisualElement which overrides any inherited data source. This data source is inherited by all children.
dataSourcePath Path from the data source to the value.
dataSourceType The possible type of data source assignable to this VisualElement. This information is only used by the UI Builder as a hint to provide some completion to the data source path field when the effective data source cannot be specified at design time.
disablePlayModeTint Play-mode tint is applied by default unless this is set to true. It's applied hierarchically to this VisualElement and to all its children that exist on an editor panel.
enabledInHierarchy Returns true if the VisualElement is enabled in its own hierarchy.
enabledSelf Returns true if the VisualElement is enabled locally.
experimental Returns the UIElements experimental interfaces.
generateVisualContent Delegate function to generate the visual content of a visual element.
hasActivePseudoState Returns true if this element matches the :active pseudo-class.
hasCheckedPseudoState Returns true if this element matches the :checked pseudo-class.
hasDisabledPseudoState Returns true if this element matches the :disabled pseudo-class.
hasEnabledPseudoState Returns true if this element matches the :enabled pseudo-class.
hasFocusPseudoState Returns true if this element matches the :focus pseudo-class.
hasHoverPseudoState Returns true if this element matches the :hover pseudo-class.
hasInactivePseudoState Returns true if this element matches the :inactive pseudo-class.
hasRootPseudoState Returns true if this element matches the :root pseudo-class.
hierarchy Access to this element physical hierarchy
languageDirection Indicates the directionality of the element's text. The value will propagate to the element's children.
layout The position and size of the VisualElement relative to its parent, as computed by the layout system. (Read Only)
localBound Returns a Rect representing the Axis-aligned Bounding Box (AABB) after applying the transform, but before applying the layout translation.
name The name of this VisualElement.
paddingRect The rectangle of the padding area of the element, in the local space of the element.
panel The panel onto which this VisualElement is attached.
parent The parent of this VisualElement.
pickingMode Determines if this element can be the target of pointer events or picked by IPanel.Pick queries.
resolvedStyle The final rendered style values of a visual element, as it's rendered in the current frame.(Read Only)
scaledPixelsPerPoint Return the resulting scaling from the panel that considers the screen DPI and the customizable scaling factor, but not the transform scale of the element and its ancestors. See Panel.scaledPixelsPerPoint. This should only be called on elements that are part of a panel.