Home > @jsplumbtoolkit/browser-ui > LoadOptions
LoadOptions interface
Options for loading data.
Signature:
export interface LoadOptions
Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| data? | any | (Optional) Optional. JSON data to load directly. | |
| dataType? | string | (Optional) Optional dataType to pass in the request | |
| error? | (e: any, status?: any) => any | (Optional) Optional function to call on load error. | |
| headers? | Record<string, string> | (Optional) Optional map of HTTP header values, if loading via URL. | |
| jsonp? | boolean | (Optional) Optional, defaults to false. Tells the Toolkit that the data is coming via JSON-P. | |
| onload? | Function | (Optional) Optional callback to execute once the data has loaded. Most often used when you are retrieving remote data (using url and possibly jsonp) | |
| parameters? | Record<string, any> | (Optional) Optional parameters to pass to the loader. | |
| type? | string | (Optional) Specifies the data type of the data to load. Defaults to json. This must match the name of a loader registered with the given instance of the Toolkit. | |
| url? | string | (Optional) URL to retrieve data from. Optional, but you need to supply either this or data. |