Component: Overlay 
-------------------

Show an overlay window with a graphic outside of FileMaker.

For macOS and Windows in FileMaker Pro.  
Coordinates are given in points, not pixels.

| Version | macOS | Windows | Linux | Server | iOS SDK |
|---|---|---|---|---|---|
| [14.1](newinversion141.md "First functions introduced with version 14.1.") / [14.2](newinversion142.md "Newest functions in version 14.2.") | ✅ Yes | ✅ 98% | ❌ No | 🔶 2%, on macOS and Windows | ❌ No |

  
| Item | Details |
|:--|:--|
| [Overlay.AddWebViewer](OverlayAddWebViewer.md)   Adds a web viewer to an overlay. | Mac/Win   14.2 |
| [Overlay.Alpha](OverlayAlpha.md)   Queries the current alpha value of the window. | Mac/Win   14.1 |
| [Overlay.Create](OverlayCreate.md)   Creates a new overlay window. | Mac/Win   14.1 |
| [Overlay.GetHasShadow](OverlayGetHasShadow.md)   Queries whether this window has a shadow. | Mac/Win   14.1 |
| [Overlay.GetHeight](OverlayGetHeight.md)   Queries height of a window. | Mac/Win   14.1 |
| [Overlay.GetLeft](OverlayGetLeft.md)   Queries X coordinate of a window. | Mac/Win   14.1 |
| [Overlay.GetMouseClickEvaluate](OverlayGetMouseClickEvaluate.md)   Queries the expression to be run on a mouse click. | Mac/Win   14.1 |
| [Overlay.GetMouseClickScriptName](OverlayGetMouseClickScriptName.md)   Queries the script to run on a mouse click. | Mac/Win   14.1 |
| [Overlay.GetMouseEnterEvaluate](OverlayGetMouseEnterEvaluate.md)   Queries the expression to be run on a mouse enters the window. | Mac/Win   14.1 |
| [Overlay.GetMouseEnterScriptName](OverlayGetMouseEnterScriptName.md)   Queries the script to run on a mouse enter. | Mac/Win   14.1 |
| [Overlay.GetMouseExitEvaluate](OverlayGetMouseExitEvaluate.md)   Queries the expression to be run on a mouse exits the window. | Mac/Win   14.1 |
| [Overlay.GetMouseExitScriptName](OverlayGetMouseExitScriptName.md)   Queries the script to run on a mouse exits. | Mac/Win   14.1 |
| [Overlay.GetMovableByWindowBackground](OverlayGetMovableByWindowBackground.md)   Queries whether the window can be moved with the mouse. | Mac/Win   14.1 |
| [Overlay.GetTag](OverlayGetTag.md)   Queries tag for window. | Mac/Win   14.1 |
| [Overlay.GetTitle](OverlayGetTitle.md)   Queries current window title. | Mac/Win   14.1 |
| [Overlay.GetTop](OverlayGetTop.md)   Queries Y coordinate of a window. | Mac/Win   14.1 |
| [Overlay.GetTopMost](OverlayGetTopMost.md)   Queries whether window is topmost. | Mac/Win   14.1 |
| [Overlay.GetWidth](OverlayGetWidth.md)   Queries width of a window. | Mac/Win   14.1 |
| [Overlay.IgnoresMouseEvents](OverlayIgnoresMouseEvents.md)   Whether the window ignores mouse events. | Mac only   14.1 |
| [Overlay.IsVisible](OverlayIsVisible.md)   Queries whether a window is visible. | Mac/Win   14.1 |
| [Overlay.List](OverlayList.md)   Lists all IDs of current overlay objects. | Mac/Win   14.1 |
| [Overlay.MouseX](OverlayMouseX.md)   Queries current position of the mouse cursor on screen. | Mac/Win   14.1 |
| [Overlay.MouseY](OverlayMouseY.md)   Queries current position of the mouse cursor on screen. | Mac/Win   14.1 |
| [Overlay.Move](OverlayMove.md)   Moves the window the given position. | Mac/Win   14.1 |
| [Overlay.Release](OverlayRelease.md)   Releases the overlay window. | Mac/Win   14.1 |
| [Overlay.ReleaseAll](OverlayReleaseAll.md)   Releases all overlay windows. | Mac/Win   14.1 |
| [Overlay.Resize](OverlayResize.md)   Resizes the window to the desired size. | Mac/Win   14.1 |
| [Overlay.SetAlpha](OverlaySetAlpha.md)   Set Alpha can be used to set the transparency of a window. | Mac/Win   14.1 |
| [Overlay.SetFocus](OverlaySetFocus.md)   Sets focus to the Window. | Mac/Win   14.1 |
| [Overlay.SetFrame](OverlaySetFrame.md)   Sets the size and position of the overlay. | Mac/Win   14.1 |
| [Overlay.SetFrameWithControl](OverlaySetFrameWithControl.md)   Sets the size and position of the overlay based on a given control. | Mac/Win   14.1 |
| [Overlay.SetHasShadow](OverlaySetHasShadow.md)   Sets whether window has a shadow. | Mac/Win   14.1 |
| [Overlay.SetIgnoresMouseEvents](OverlaySetIgnoresMouseEvents.md)   Sets whether the window ignores mouse clicks. | Mac/Win   14.1 |
| [Overlay.SetImage](OverlaySetImage.md)   Sets the image to show in the container. | Mac/Win   14.1 |
| [Overlay.SetMouseClickEvaluate](OverlaySetMouseClickEvaluate.md)   Sets expression to be run on a mouse click. | Mac/Win   14.1 |
| [Overlay.SetMouseClickScript](OverlaySetMouseClickScript.md)   Sets the script to run on a mouse click. | Mac/Win   14.1 |
| [Overlay.SetMouseEnterEvaluate](OverlaySetMouseEnterEvaluate.md)   Sets expression to be run on a mouse enter. | Mac/Win   14.1 |
| [Overlay.SetMouseEnterScript](OverlaySetMouseEnterScript.md)   Sets the script to run on a mouse enter. | Mac/Win   14.1 |
| [Overlay.SetMouseExitEvaluate](OverlaySetMouseExitEvaluate.md)   Sets expression to be run on a mouse exit. | Mac/Win   14.1 |
| [Overlay.SetMouseExitScript](OverlaySetMouseExitScript.md)   Sets the script to run on a mouse exit. | Mac/Win   14.1 |
| [Overlay.SetMovableByWindowBackground](OverlaySetMovableByWindowBackground.md)   Sets whether the window can be moved with the mouse. | Mac/Win   14.1 |
| [Overlay.SetTag](OverlaySetTag.md)   Sets tag for window. | Mac/Win   14.1 |
| [Overlay.SetTitle](OverlaySetTitle.md)   Sets the window title. | Mac/Win   14.1 |
| [Overlay.SetTopMost](OverlaySetTopMost.md)   Sets window to be topmost. | Mac/Win   14.1 |
| [Overlay.SetVisible](OverlaySetVisible.md)   Sets whether the window is visible. | Mac/Win   14.1 |

45 functions shown.

### Release notes

- **Version 16.2**
    - Added flags parameter for [Overlay.AddWebViewer](https://www.mbsplugins.eu/OverlayAddWebViewer.shtml), [WebView.Create](https://www.mbsplugins.eu/WebViewCreate.shtml), [WebView.CreateWindow](https://www.mbsplugins.eu/WebViewCreateWindow.shtml) and [WebView.CreateWithControl](https://www.mbsplugins.eu/WebViewCreateWithControl.shtml) functions to control whether script triggers or Evaluate are allowed.
- **Version 16.0**
    - Improved [Overlay.AddWebViewer](https://www.mbsplugins.eu/OverlayAddWebViewer.shtml) on handle fmp:// URL within the WebViewer and trigger them in FileMaker.
- **Version 14.5**
    - Added [Overlay.AddWebViewer](https://www.mbsplugins.eu/OverlayAddWebViewer.shtml) function.
- **Version 14.2**
    - Added AnimationTime parameter for [Overlay.Move](https://www.mbsplugins.eu/OverlayMove.shtml) function.
    - Improved [Overlay](https://www.mbsplugins.eu/component_Overlay.shtml) functions to resize the image automatically to fill window size on Windows.
- **Version 14.1**
    - Added [Overlay](https://www.mbsplugins.eu/component_Overlay.shtml) functions to show little graphics on screen independent of FileMaker.

### Blog Entries

- [MBS FileMaker Advent calendar - Door 3 - Drag &amp; Drop](https://www.mbsplugins.de/archive/2024-12-03/MBS_FileMaker_Advent_calendar_/monkeybreadsoftware_blog_filemaker)
- [Add a WebViewer to an Overlay window](https://www.mbsplugins.de/archive/2024-11-13/Add_a_WebViewer_to_an_Overlay_/monkeybreadsoftware_blog_filemaker)
- [MBS @ FMTraining.TV - MonkeyBread Plug-in Q&amp;A with Christian Schmitz](https://www.mbsplugins.de/archive/2024-09-05/MBS_@_FMTrainingTV_-_MonkeyBre/monkeybreadsoftware_blog_filemaker)
- [MBS @ FMTraining.TV - The FileMaker MonkeyBread Plug-in - 14.3 Update with Christian Schmitz](https://www.mbsplugins.de/archive/2024-08-29/MBS_@_FMTrainingTV_-_The_FileM/monkeybreadsoftware_blog_filemaker)
- [MBS FileMaker Plugin 14.3 News](https://www.mbsplugins.de/archive/2024-07-17/MBS_FileMaker_Plugin_143_News/monkeybreadsoftware_blog_filemaker)
- [MBS @ FMTraining.TV - The FileMaker Monkeybread Plug-in 14.1 with Christian Schmitz](https://www.mbsplugins.de/archive/2024-04-10/MBS_@_FMTrainingTV_-_The_FileM/monkeybreadsoftware_blog_filemaker)
- [New in MBS FileMaker Plugin 14.1](https://www.mbsplugins.de/archive/2024-03-19/New_in_MBS_FileMaker_Plugin_14/monkeybreadsoftware_blog_filemaker)
- [MBS Plugin 14.1 for Claris FileMaker](https://www.mbsplugins.de/archive/2024-03-12/MBS_Plugin_141_for_Claris_File/monkeybreadsoftware_blog_filemaker)
- [MBS @ FMTraining.TV - FileMaker MBS 14.1 Preview](https://www.mbsplugins.de/archive/2024-03-07/MBS_@_FMTrainingTV_-_FileMaker/monkeybreadsoftware_blog_filemaker)
- [Overlay windows for FileMaker](https://www.mbsplugins.de/archive/2024-02-28/Overlay_windows_for_FileMaker/monkeybreadsoftware_blog_filemaker)

### FileMaker Magazin

- [Ausgabe 4/2025, Seite 28 bis 31](https://filemaker-magazin.de/neuigkeit/4297-Appetithappen-FMM_202504)

### Example Databases

- [Drag and Drop/DragTest](https://www.mbsplugins.eu/MBS-FileMaker-Plugin-Examples/Drag%20and%20Drop/DragTest.shtml#11ScriptAnchor_)
- [Overlay](https://www.mbsplugins.eu/MBS-FileMaker-Plugin-Examples/Overlay.shtml#1ScriptAnchor_)

[HTML Version](component_Overlay.shtml)