This article covers the following platforms
MSFS 2024
MSFS 2020
ATS
FSX
Prepar3D
Use the Toolbar API to inspect, open, close, or toggle simulator in-game panels.
get_panels()
Get every in-game panel available to Flow.
SignatureTypeScript contract
get_panels(): unknown[]ExampleJavaScript
const panels = this.$api.toolbar.get_panels();
console.log(panels);Returns
unknown[]Array of available in-game panels.get_panel()
Get information about one in-game panel.
SignatureTypeScript contract
get_panel(panel_id: string): unknownParameters
| Name | Type | Required | Description |
|---|---|---|---|
panel_id | string | Yes | Panel ID. Use get_panels() to obtain an available ID. |
ExampleJavaScript
const panel = this.$api.toolbar.get_panel("PANEL_ID");
console.log(panel);Returns
unknownInformation for the requested in-game panel.open_panel()
Open an in-game panel.
SignatureTypeScript contract
open_panel(panel_id: string): voidParameters
| Name | Type | Required | Description |
|---|---|---|---|
panel_id | string | Yes | Panel ID. Use get_panels() to obtain an available ID. |
ExampleJavaScript
this.$api.toolbar.open_panel("PANEL_ID");Returns
voidNo direct return value is documented.close_panel()
Close an in-game panel.
SignatureTypeScript contract
close_panel(panel_id: string): voidParameters
| Name | Type | Required | Description |
|---|---|---|---|
panel_id | string | Yes | Panel ID. Use get_panels() to obtain an available ID. |
ExampleJavaScript
this.$api.toolbar.close_panel("PANEL_ID");Returns
voidNo direct return value is documented.toggle_panel()
Toggle an in-game panel between its open and closed states.
SignatureTypeScript contract
toggle_panel(panel_id: string): voidParameters
| Name | Type | Required | Description |
|---|---|---|---|
panel_id | string | Yes | Panel ID. Use get_panels() to obtain an available ID. |
ExampleJavaScript
this.$api.toolbar.toggle_panel("PANEL_ID");Returns
voidNo direct return value is documented.