Skip to content

The Wheel

Check the Flow Wheel's position and visibility from a Flow Pro script.

Updated View as Markdown
For humans
Flow APIFlow Pro scriptingWheel and interface

This article covers the following platforms

Use the Command API to inspect the Flow Wheel’s on-screen location and visibility.

get_wheel_location()

Get the Flow Wheel’s on-screen position in pixels.

SignatureTypeScript contract
get_wheel_location(): [number, number]
ExampleJavaScript
const [x, y] = this.$api.command.get_wheel_location();
console.log({ x, y });

Returns

[number, number]Flow Wheel x and y position in pixels.

get_wheel_state()

Check whether the Flow Wheel is visible.

SignatureTypeScript contract
get_wheel_state(): boolean
ExampleJavaScript
const isVisible = this.$api.command.get_wheel_state();
console.log(isVisible);

Returns

booleanWhether the Flow Wheel is currently visible.
Navigation

Type to search…

↑↓ navigate↵ selectEsc close