---
title: "floatWindow"
canonical: "https://help.vicon.com/space/ShogunPost121/1253737910/floatWindow"
format: markdown
---
# Description

Floats a docking window.

This command gives the user the ability to programmatically "float" a docking window, as well as control its position on the screen. Usually, the user does this by clicking and dragging the mouse.

If neither `-left` nor `-top` are specified, the docking window's position is cascaded in relation to other docking windows.

Both Shogun Post's docking windows and user windows can be controlled using this command.

## Functional area

Interface

# Command syntax

## Syntax

> Macro (scroll-tablelayout)

|  |
| --- |
| `floatWindow "windowName" [-left integer] [-top integer] [-width integer] [-height integer]` |

### Arguments

> Macro (scroll-tablelayout)

| Name | Type | Required | Comments |
| --- | --- | --- | --- |
| `windowName` | string | yes | Name of the window to float. Can be one ofShogun Post's docking windows or a user window. |

> Macro (scroll-pagebreak)

### Flags

> Macro (scroll-tablelayout)

| Name | Flag arguments | Argument type | Exclusive to | Comments |
| --- | --- | --- | --- | --- |
| `left` | 1 | integer | — | Specifies the position, in pixels, of the left side of the docking window, from the top left corner of the screen. |
| `top` | 1 | integer | — | Specifies the position, in pixels, of the top side of the docking window, from the top left corner of the screen. |
| `width` | 1 | integer | — | Specifies the width, in pixels, of the docking window |
| `height` | 1 | integer | — | Specifies the height in pixels, of the docking window |

## Return value

void

## Examples

```plaintext
// Create a user window and specify its screen position and size 
createWindow "FloatTest";
floatWindow "FloatTest" -left 100 -top 300 -width 300 -height 200;
```

# Additional information

## Related commands

- [autohideWindow](https://vicon-help.atlassian.net/wiki/spaces/ShogunPost121/pages/1253736717)
- [dockWindow](https://vicon-help.atlassian.net/wiki/spaces/ShogunPost121/pages/1253736761)
- [setWindowSize](https://vicon-help.atlassian.net/wiki/spaces/ShogunPost121/pages/1253738927)
- [showWindow](https://vicon-help.atlassian.net/wiki/spaces/ShogunPost121/pages/1253736492)
- [tabWindow](https://vicon-help.atlassian.net/wiki/spaces/ShogunPost121/pages/1253736988)