Skip to content
pixi-silk
GitHub repository
Function

dockRect

import { dockRect } from 'pixi-silk/ui/panel';
function dockRect(
   dock: PanelDock, 
   viewport: {
  height: number;
  width: number;
}, 
   size: {
  height: number;
  width: number;
}, 
   margin?: number, 
   insets?: PanelInsets
): PanelRect;

Where a panel of size sits when docked to dock in a screen of viewport. Left and right panels span the height between the insets, top and bottom ones the width.

Parameters#

ParameterTypeDefault value
dockPanelDockundefined
viewport{ height: number; width: number; }undefined
viewport.heightnumberundefined
viewport.widthnumberundefined
size{ height: number; width: number; }undefined
size.heightnumberundefined
size.widthnumberundefined
marginnumber8
insetsPanelInsets{}

Returns#

PanelRect