GraffitiSuite Docs
Docs
Graffitipreloader
Loading document parsing libraries...
# GraffitiPreloader Class Inherits WebSDKControl ## About Show a custom message with spinner as your application renders in users' browsers. Reduced the amount of time users feel like they're waiting for your application to become usable. ## Compatibility ### Framework API Version | 1.0 | 2.0 | | :---: | :---: | | True | True | ## Attributes | Name | Value | | --- | --- | | HideFromLibrary | | ## Enumerations | Name | Value | Description | | --- | :---: | --- | | SpinnerStyles | Bounce <br> Chase <br> Circle <br> CircleFade <br> Flow <br> Fold <br> Grid <br> Plane <br> Pulse <br> Swing <br> Wander <br> Wave | Supported spinner styles. | ## Methods | Name | Parameters | Return Type | Description | | --- | :---: | :---: | --- | | Attributes | Hidden | Function | | ## Shared Methods | Name | Parameters | Return Type | Description | | --- | :---: | :---: | --- | | Hide | (None) | (None) | Hides the spinner. | | Show | (None) | (None) | Shows the preload spinner. | ## Shared Properties | Name | Type | Default Value | Description | | --- | :---: | :---: | --- | | AutoShow | Boolean | False | Controls whether the preloader will be immediately visible on page load. | | BackgroundColor | Color | Nil | Background color used to obscure content behind the preloader. | | ForegroundColor | Color | &c3498db | Color applied to the preload spinner. | | Height | Integer | 40 | Height of the preload spinner. | | StatusText | String | "Loading | Text to display below the preload spinner. | | Style | SpinnerStyles | Nil | Style of spinner to display. | | Width | Integer | 40 | Width of the preload spinner. | ## Examples ### Setting Properties As all properties are shared, all sessions created will see the same Preloader screen. Properties should be set in the App.Opening event like so: ``` GraffitiPreloader.AutoShow = True GraffitiPreloader.Style = GraffitiPreloader.SpinnerStyles.Swing GraffitiPreloader.Width = 100 GraffitiPreloader.Height = 100 GraffitiPreloader.StatusText = "Spraying . . ." ```