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.
CloseFor 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.
CloseThis property controls the scrolling speed only when using a mouse scroll wheel, based on the size of the page.
This property takes precedence over the --unity-metrics-single_line-height
USS variable. If both the property and the variable
are set, the property value is used.
The following example demonstrates how to use the mouseWheelScrollSize
property to control the "speed" of a scroll
when using the mouse wheel. Notice the difference in feel when selecting different values:
using System.Collections.Generic; using UnityEngine; using UnityEngine.UIElements;
[RequireComponent(typeof(UIDocument))] public class ScrollView_MouseWheelScrollSize : MonoBehaviour { // To use this example in runtime, add a UIDocument component to your Scene and attach a UXML file to the UIDocument component. // The UXML file can be empty. public UIDocument uiDocument; public int numberOfPotions = 100;
void Start() { // Create a dropdown to change the mouse wheel scroll size. var mouseWheelScrollSizeDropdown = new DropdownField("Select a Mouse Wheel Scroll Size");
var scrollView = new ScrollView { name = "MyPotionsInventory" }; scrollView.style.height = 200;
var initialMouseWheelScrollSize = scrollView.mouseWheelScrollSize;
// Set the choices of the dropdown to different values of the mouse wheel scroll size. mouseWheelScrollSizeDropdown.choices = new List<string>() { $"{initialMouseWheelScrollSize * 0.5f}", $"{initialMouseWheelScrollSize}", $"{initialMouseWheelScrollSize * 2}", $"{initialMouseWheelScrollSize * 10}", $"{initialMouseWheelScrollSize * 20}" }; mouseWheelScrollSizeDropdown.value = $"{initialMouseWheelScrollSize}";
// Register a ValueChangedCallback to change the mouse wheel scroll size. mouseWheelScrollSizeDropdown.RegisterValueChangedCallback(evt => { // We know the choices are all floats, so we can parse them directly. var newValue = float.Parse(evt.newValue); scrollView.mouseWheelScrollSize = newValue;
});
var inventoryColor = new Color(0.65f, 0.3f, 0.2f, 1f);
// Create a list of labels representing potions. for (int i = 0; i < numberOfPotions; i++) { var label = new Label { text = " Unnamed Potion #" + (i) }; label.style.backgroundColor = inventoryColor; scrollView.Add(label); }
// Add a title for the list and make it noticeable. var title = new Label { text = "Potions Inventory" }; title.style.unityFontStyleAndWeight = FontStyle.Bold; title.style.fontSize = 20; title.style.color = inventoryColor; title.style.unityTextAlign = TextAnchor.MiddleCenter;
uiDocument.rootVisualElement.Add(mouseWheelScrollSizeDropdown); uiDocument.rootVisualElement.Add(title); uiDocument.rootVisualElement.Add(scrollView); } }
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.