Giraffe SDK

gi-nx / GiraffeStateUiLayout

type GiraffeStateUiLayout = {
  uiLayout: {
     controlled: {
        leftBarOpen: boolean;
        leftBarOpenWidth: number;
        lensTableHeight: number;
        rightBarOpen: boolean;
        rightBarOpenWidth: number;
        sdkPopupOpen: boolean;
     };
     derived: {
        bottomBarIframeHeight: number;
        leftBarWidth: number;
        lensTableHeight: number;
        rightBarWidth: number;
     };
     setBySdk: {
        bottomBarIframe:   | {
           height: number;
           url: string;
         }
           | null;
        contextMenuItems: {
           label: string;
        }[];
        disableLensSelectionDrawer: boolean;
        disableProjectRightDrawer: boolean;
        secondaryApp: "Urban" | "Analytics" | "Solar" | "Terrain" | null;
     };
     windowDimensions: {
        height: number;
        width: number;
     };
  };
};

Properties

Property	Type	Description
`uiLayout.controlled`	{ `leftBarOpen`: `boolean`; `leftBarOpenWidth`: `number`; `lensTableHeight`: `number`; `rightBarOpen`: `boolean`; `rightBarOpenWidth`: `number`; `sdkPopupOpen`: `boolean`; }	-
`uiLayout.controlled.leftBarOpen`	`boolean`	-
`uiLayout.controlled.leftBarOpenWidth`	`number`	-
`uiLayout.controlled.lensTableHeight`	`number`	-
`uiLayout.controlled.rightBarOpen`	`boolean`	-
`uiLayout.controlled.rightBarOpenWidth`	`number`	-
`uiLayout.controlled.sdkPopupOpen`	`boolean`	-
`uiLayout.derived`	{ `bottomBarIframeHeight`: `number`; `leftBarWidth`: `number`; `lensTableHeight`: `number`; `rightBarWidth`: `number`; }	-
`uiLayout.derived.bottomBarIframeHeight`	`number`	-
`uiLayout.derived.leftBarWidth`	`number`	-
`uiLayout.derived.lensTableHeight`	`number`	-
`uiLayout.derived.rightBarWidth`	`number`	-
`uiLayout.setBySdk`	{ `bottomBarIframe`: \| { `height`: `number`; `url`: `string`; } \| `null`; `contextMenuItems`: { `label`: `string`; }[]; `disableLensSelectionDrawer`: `boolean`; `disableProjectRightDrawer`: `boolean`; `secondaryApp`: `"Urban"` \| `"Analytics"` \| `"Solar"` \| `"Terrain"` \| `null`; }	-
`uiLayout.setBySdk.bottomBarIframe`	\| { `height`: `number`; `url`: `string`; } \| `null`	Configuration for an iframe rendered in the bottom bar of the Giraffe UI
`uiLayout.setBySdk.contextMenuItems`	{ `label`: `string`; }[]	Custom items added to the map's right-click context menu
`uiLayout.setBySdk.disableLensSelectionDrawer`	`boolean`	Only relevant in a space, not a project. Prevents project or feature details from showing over the top of the app
`uiLayout.setBySdk.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
`uiLayout.setBySdk.secondaryApp`	`"Urban"` \| `"Analytics"` \| `"Solar"` \| `"Terrain"` \| `null`	An app that the SDK can overlay over itself (without closing)
`uiLayout.windowDimensions`	{ `height`: `number`; `width`: `number`; }	-
`uiLayout.windowDimensions.height`	`number`	-
`uiLayout.windowDimensions.width`	`number`	-

Properties ​

Properties