Api
Classes
CanvasPanel
chevron_left Classes
class
CanvasPanel

Constructors

functionsCanvasPanel

Properties

data_objectBoxSelectionEnabledlockCanNavigatedata_objectConstrainHorizontalNavigationdata_objectConstrainVerticalNavigationdata_objectContentdata_objectIsBoxSelectingdata_objectIsPanningdata_objectMaximumViewSpandata_objectMinimumViewSpandata_objectNavigationBoundsdata_objectPreserveAspectRatiodata_objectSelectionBoxdata_objectViewMaxdata_objectViewMinlockViewportdata_objectYAxisUp

Methods

lockBeginBoxSelectionfunctionsCanvasToScreenlockFinishBoxSelectionfunctionsFitBoundslockOnBlurfunctionsOnButtonTypedlockOnMouseDownlockOnMouseMovelockOnMouseUpfunctionsOnMouseWheelfunctionsPanfunctionsScreenToCanvasfunctionsSetViewfunctionsTickfunctionsZoomAt
CanvasPanel
A navigable drawing surface. Owns the view transform, cursor-anchored zoom and middle-button panning. Add ordinary panels to Content, or draw directly with Painter. Coordinates returned by CanvasToScreen are local screen pixels, matching Painter and MousePosition.
class Sandbox.UI .account_tree extends Panel
Sandbox.Engine

build Constructors 1

CanvasPanel ()

data_object Properties 16

BoxSelectionEnabled
bool
Allow left-dragging empty canvas space to draw a selection rectangle. Off by default.
CanNavigate
bool
ConstrainHorizontalNavigation
bool
Apply the horizontal limits of NavigationBounds. Enabled by default.
ConstrainVerticalNavigation
bool
Apply the vertical limits of NavigationBounds. Disable to pan and zoom freely above and below them.
Content
Panel
Ordinary panels placed in canvas coordinates. Their CSS transforms, layout, focus and input work normally. The content has a stable 1000 x 1000 layout size (set its Style to change it), with visible overflow so panels can also be placed at negative or larger coordinates. Pan/zoom transform the whole subtree without changing its layout. Created only when used.
IsBoxSelecting
bool
IsPanning
bool
MaximumViewSpan
float
MinimumViewSpan
float
NavigationBounds
Nullable`1
Optional limits in canvas coordinates. Enabled axes stay inside this rectangle when panning, zooming or resizing.
PreserveAspectRatio
bool
Fit the requested view uniformly, revealing extra space around its centre. Disable for independent graph axes.
SelectionBox
Nullable`1
The current selection rectangle in canvas coordinates, or null when not selecting.
ViewMax
Vector2
ViewMin
Vector2
Viewport
Rect
YAxisUp
bool

functions Methods 15

BeginBoxSelection (additive)
Start a box gesture after a custom canvas has checked its own hit targets.
CanvasToScreen (point)
Vector2
FinishBoxSelection (cancelled)
Complete or cancel the active selection gesture.
FitBounds (bounds, padding, minimumPadding)
Frame bounds in canvas coordinates with padding on each side, expressed as a fraction of their size. Minimum padding is in canvas units. Navigation limits take precedence.
OnBlur (e)
OnButtonTyped (e)
OnMouseDown (e)
OnMouseMove (e)
OnMouseUp (e)
OnMouseWheel (value)
Pan (screenDelta)
ScreenToCanvas (point)
Vector2
SetView (min, max)
Set finite, increasing bounds to fit in the viewport without modifying the content.
Tick ()
ZoomAt (screenAnchor, factor)
Scale the visible span while keeping the screen anchor fixed.

Inheritance

Panel
CanvasPanel
GraphPanel
people
Log in to reply
You can't reply if you're not logged in. That would be crazy.