GraffitiSuite Docs
Docs
Graffitisidebar
Loading document parsing libraries...
# GraffitiSidebar Class Inherits GraffitiWebUIControl ## About A sliding drawer component to create good-looking off-canvas menus or content. ## Compatibility ### Framework API Version | 1.0 | 2.0 | | :---: | :---: | | True | True | ### Web | 32-Bit | 64-Bit | | :---: | :---: | | True | True | ## Enumerations | Name | Value | Description | | --- | :---: | --- | | Positions | SideLeft <br > SideRight | Supported window sides. | ## Event Definitions | Name | Parameters | Return Type | Description | | --- | :---: | :---: | --- | | BarClose | (None) | (None) | The has successfully closed. | | BarOpen | (None) | (None) | The bar has successfully opened. | | Open | (None) | (None) | (None) | | Shown | (None) | (None) | (None) | ## Methods | Name | Parameters | Return Type | Description | | --- | :---: | :---: | --- | | BindTo | element as WebControl | (None) | Binds to a control via JavaScript to toggle the sidebar without a server round-trip. | | CloseBar | (None) | (None) | Closes the bar. | | OpenBar | (None) | (None) | Open the bar. | | ToggleBar | (None) | (None) | Toggles whether the bar is currently visible. | ## Properties | Name | Type | Default Value | Description | | --- | :---: | :---: | --- | | AnimationSpeed | Integer | (None) | This classes exposes no properties. | | Container | WebContainer | (None) | The container to embed within the sidebar. | | DisplaySide | Positions | (None) | On which side of the page the sidebar will be displayed. | | HasClose | Boolean | (None) | Controls visibility of the close button. | | HasHeader | Boolean | (None) | Controls visibility of the header. | | IsOpen | Boolean | (None) | Returns true if the sidebar is currently visible on the page. | | Title | String | (None) | Header title text. |
