Giraffe SDK

gi-nx / SdkUiLayout

type SdkUiLayout = {
  activeOverlay?: GiraffeOverLays;
  bottomBarIframe?:   | {
     height: number;
     url: string;
   }
     | null;
  disableLensSelectionDrawer?: boolean;
  disableProjectRightDrawer?: boolean;
  leftBarOpen?: boolean;
  leftBarOpenWidth?: number;
  lensTableHeight?: number;
  lensTableMode?: "default" | "collapsed" | "fullscreen";
  rightBarOpen?: boolean;
  rightBarOpenWidth?: number;
  sdkPopupOpen?: boolean;
};

Options for updateUiLayout. All fields are optional — only those provided are applied.

Properties

Property	Type	Description
`activeOverlay?`	`GiraffeOverLays`	Active full-screen overlay (e.g. 'AllLayers', 'Screenshot')
`bottomBarIframe?`	\| { `height`: `number`; `url`: `string`; } \| `null`	Configuration for an iframe rendered in the bottom bar of the Giraffe UI
`disableLensSelectionDrawer?`	`boolean`	Only relevant in a space, not a project. Prevents project or feature details from showing over the top of the app
`disableProjectRightDrawer?`	`boolean`	Only relevant in a space. Suppresses the project preview drawer that opens on the right when a project is left-clicked on the map
`leftBarOpen?`	`boolean`	Show or hide the left sidebar
`leftBarOpenWidth?`	`number`	Width of the left sidebar in pixels
`lensTableHeight?`	`number`	Height of the lens (selected layer) table in pixels
`lensTableMode?`	`"default"` \| `"collapsed"` \| `"fullscreen"`	Display mode of the lens (selected layer) table
`rightBarOpen?`	`boolean`	Show or hide the right sidebar
`rightBarOpenWidth?`	`number`	Width of the right sidebar in pixels
`sdkPopupOpen?`	`boolean`	Whether an SDK-owned popup is currently open

Properties ​

Properties