luadocs/content/lua.api.manual/events/global_toolbox-overlay_toggle.md

---
title: global_toolbox-overlay_toggle
id: global_toolbox-overlay_toggle
weight: 40
draft: false
author: "people"
---

`event`

This event is triggered after the user toggled the overlay button.

# global_toolbox-overlay_toggle.callback

```
function(
  toggle : boolean
)
```

* **toggle** - _boolean_ - the new overlay status.

# global_toolbox-overlay_toggle.extra registration parameters

This event has no extra registration parameters.
[lua.api.manual] Converted from xml to markdown. Still needs work, but now we have a current reference on-line 2020-12-21 18:18:08 +00:00			`---`
			`title: global_toolbox-overlay_toggle`
			`id: global_toolbox-overlay_toggle`
Added Lua API 6.2.1 changes (selection-changed event, event naming, and darktable.destroy_event). Reordered darktable and event sections alphabetically except where grouping made sense. 2021-02-04 03:14:39 +00:00			`weight: 40`
[lua.api.manual] Converted from xml to markdown. Still needs work, but now we have a current reference on-line 2020-12-21 18:18:08 +00:00			`draft: false`
			`author: "people"`
			`---`

			`event`

			`This event is triggered after the user toggled the overlay button.`

			`# global_toolbox-overlay_toggle.callback`

			```
			`function(`
			`toggle : boolean`
			`)`
			```

			`* toggle - _boolean_ - the new overlay status.`

			`# global_toolbox-overlay_toggle.extra registration parameters`

			`This event has no extra registration parameters.`