Global

Methods

clearInterval(timerID)

Parameters:
Name Type Description
timerID number

clearTimeout(timerID)

Parameters:
Name Type Description
timerID number

include(path, optionsopt)

Evaluates the script in file.
Similar to `eval(utils.ReadTextFile(path))`, but provides more features:
- Has `include guards` - script won't be evaluated a second time if it was evaluated before in the same panel.
- Has script caching - script file will be read only once from filesystem (even if it is included from different panels).
- Has better error reporting.

Note: when the relative `path` is used it will be evaluated to the following values:
- `${fb.ComponentPath}/${path}`, if the method is invoked from a top-level script (i.e. panel's `Configure` dialog).
- `${current_script_path}/${path}`, otherwise.
Parameters:
Name Type Attributes Description
path string Absolute or relative path to JavaScript file.
options object <optional>
Properties
Name Type Attributes Default Description
always_evaluate boolean <optional>
false If true, evaluates the script even if it was included before.
Example

Include sample from `foo_spider_monkey_panel`

include('samples/complete/properties.js')

setInterval(func, delay, …func_argsopt) → {number}

Parameters:
Name Type Attributes Description
func function
delay number
func_args * <optional>
<repeatable>
Returns:
number

setTimeout(func, delay, …func_argsopt) → {number}

Parameters:
Name Type Attributes Description
func function
delay number
func_args * <optional>
<repeatable>
Returns:
number
Example
// See `samples/basic/Timer.js`

Type Definitions

ArtPromiseResult

Properties:
Name Type Attributes Description
image GdiBitmap <nullable>
null on failure
path string path to image file (or track file if image is embedded)

float