Version: 2022.1
LanguageEnglish
  • C#

DockPosition

enumeration

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

DockPosition describes the alignment of an Overlay within a DockZone.

Use DockPosition in an OverlayAttribute to set the default location for an Overlay.

using UnityEditor;
using UnityEditor.Overlays;
using UnityEngine;
using UnityEngine.UIElements;

// Use OverlayAttribute to specify that in new Scene Views, when this Overlay is first opened it will be in the // top toolbar, aligned to the left side. [Overlay(typeof(SceneView), "Docked Top Toolbar, Left Aligned", defaultDockZone = DockZone.TopToolbar, defaultDockPosition = DockPosition.Top)] class MyOverlay : Overlay { public override VisualElement CreatePanelContent() => new Label("Overlay Contents"); }

Properties

TopThe Overlay will be aligned to the top or left of the DockZone.
BottomThe Overlay will be aligned to the bottom or right of the DockZone.