Keyboard Maestro Wiki

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
The [[function:SCREEN|SCREEN()]] and [[function:SCREENVISIBLE|SCREENVISIBLE()]] functions return the position or size of a screen.  [[function:SCREENVISIBLE|SCREENVISIBLE()]] refers to the visible section of the screen, excluding the menu bar and the dock.

    SCREEN( index [number OR name], coordinate )
    SCREEN( index [number OR name], coordinate, percentage )

The SCREEN *index* can be referenced by either a _number_ OR a _name_.  The _Index number_ can be 0 for the main screen, and then 1 through n are the screens in orientation order from left to right (and top down for screens at the same position).  _Index Names_ are shown below.

The _Main_ screen is set by your macOS System Preferences.
The other screens (monitors) are referenced positionally from the left most screen, which may, or _may not_, be the _Main_ screen.

^ Index Name ^ Description ^
| **Main** | the screen with the primary menu bar (as configured in the Displays preferences).|
| Second |the first from the left which is not the _Main_ screen.|
| Third | the second from the left which is not the _Main_ screen.|
| Internal | the internal screen of the Mac.|
| External | the first from the left which is not an internal screen.|
| Mouse | the screen containing the mouse.|
| Front | the screen containing (the most of) the front window.|
| Back | the first from the left not containing (the most of) the front window.|
| Back2 | the second left most screen not containing (the most of) the front window.|

:!: Note: Since the _Main_ screen can be in any position, be advised of the following:
  * SCREEN(0) is always the _Main_ screen.
  * SCREEN(1) may or may not be the _Main_ screen.
  * SCREEN(2+) may or may not be the _Main_ screen.


The SCREEN *coordinate* can be:

* Left
* Right
* Top
* Bottom
* Width
* Height
* MidX
* MidY

The optional SCREEN *percentage* parameter specifies a percentage of the width or height to offset by. Offsets are always to the right and down, but negative offsets are allowed.

For example SCREEN(Internal,Left,10%) would be the coordinate of left edge of the internal screen plus 10% of the width of the internal screen. SCREEN(Front,Right,-10%) would be the coordinate of the right edge of the external screen minus 10% of the width of the external screen.

SCREEN sizes and positions are in //nominal resolution pixels// (so a retina screen will typically have half as many nominal resolution pixels as raw pixels).

Coordinates are in absolute coordinates (relative to the top left corner of the main screen).

===== See Also =====

----

==== Actions ====

* [[action:Manipulate a Window|Manipulate a Window]]
* [[action:Move or Click Mouse|Move or Click Mouse]]
* [[:Actions|See all Actions]]

==== Functions ====

* [[function:MENUBARHEIGHT|MENUBARHEIGHT()]]
* [[function:MOUSEBUTTON|MOUSEBUTTON()]]
* [[function:MOUSEX|MOUSEX()]]
* [[function:MOUSEY|MOUSEY()]]
* [[function:SCREENCOUNT|SCREENCOUNT()]]
* [[function:WINDOW|WINDOW()]]
* [[function:WINDOWCOUNT|WINDOWCOUNT()]]
* [[:Functions|See all Functions]]

=== Tokens ===

* [[token:Screen|%Screen%]]
* [[token:ScreenVisible|%ScreenVisible%]]
* [[:Tokens|See all Tokens]]

----

==== Forum ====

- [[https://forum.keyboardmaestro.com/t/i-need-a-conditional-if-there-are-two-monitors/3031/5|I need a conditional if there are two monitors]]

- [[https://forum.keyboardmaestro.com/search?q=Screen|Keyboard Maestro Forum topics about Screen]]
Keyboard Maestro Wiki

User Tools

Site Tools

Page Tools
