Unity UI: Unity User Interface
ViewData persistence
The ViewData API solves the problem of having a UI-specific state, not part of
the data, survive domain reload and Editor restarts. The idea is to have a
persistent data store on each EditorWindow
. Each VisualElement
has a
viewDataKey
that must be set in order to enable ViewData
persistence.
Usage
To enable view data persistence for an element that supports it, set the viewDataKey
to a unique key within your EditorWindow
.
Persistence of view data is enabled as long as an element has a valid viewDataKey
. The only exception is when an element is in the shadow tree of its parent and not a physical child of its logical parent’s contentContainer
. In this case, the parent must have its own viewDataKey
set for the children in its shadow tree to be persisted.
For example, in ScrollView
, each scroll bar has its own viewDataKey
that is unique within the ScrollView
element. When the ScrollView
has no key set,
the scroll bars are not persisted. Otherwise, the scroll bars will combine their viewDataKey
with the parent viewDataKey
to create a globally unique key.
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?
Is something described here not working as you expect it to? It might be a Known Issue. Please check with the Issue Tracker at issuetracker.unity3d.com.
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:
Thanks for helping to make the Unity documentation better!
Unity UI: Unity User Interface