# system.perspective.alterDock Params

**URL:** <https://forum.inductiveautomation.com/t/system-perspective-alterdock-params/114641>\
**Category:** Ignition\
**Tags:** ignition81, perspective\
**Created:** [March 24, 2026, 12:51pm UTC](https://forum.inductiveautomation.com/t/system-perspective-alterdock-params/114641 "2026-03-24T12:51:06Z")\
**Posts on this page:** 7\
**Page:** 1

<div class="post-metadata">

**Author:** ![deon.korb](https://avatars.discourse-cdn.com/v4/letter/d/8c91f0/32.png) [@deon.korb](https://forum.inductiveautomation.com/u/deon.korb)\
**Post date:** [March 24, 2026, 12:51pm UTC](https://forum.inductiveautomation.com/t/system-perspective-alterdock-params/114641/1 "2026-03-24T12:51:06Z")

</div>

Hi,

I have a dock that usually hides (display = onDemand), and want to programmatically change it to visible under certain conditions.

The docs are in conflict with the GUI, where the display options relate to the content options. See below:

- **display** : The display state of the dock. Accepted values are:

 ![image](https://us1.discourse-cdn.com/inductiveautomation/original/3X/7/7/77a9b07778e9268ed8191235c858e55c027b67ae.png)

I tried this, without success (also no exception):

```python
		if show:			
			config = {"display":"visible"}
		else:
			config = {"display":"onDemand"}
		system.perspective.alterDock('dockWest', config)

```

Can someone please point me in the right direction?

8.1.50 for reference.

Regards,

Deon

---

<div class="post-metadata">

**Author:** ![Samuel\_Sueur](https://avatars.discourse-cdn.com/v4/letter/s/e36b37/32.png) [@Samuel\_Sueur](https://forum.inductiveautomation.com/u/Samuel_Sueur)\
**Post date:** [March 24, 2026, 12:57pm UTC](https://forum.inductiveautomation.com/t/system-perspective-alterdock-params/114641/2 "2026-03-24T12:57:58Z")

</div>

Hi,

Whilst I do agree this is weird, especially on the different options for `display`, why don’t you simply use `system.perspective.closeDock` and `system.perspective.openDock` ?

`system.perspective.toggleDock` also exists in case you do not keep track of the state of the dock.

Unless obviously you want to change more parameters, but this is also doable using the functions I mentioned above.

---

<div class="post-metadata">

**Author:** ![deon.korb](https://avatars.discourse-cdn.com/v4/letter/d/8c91f0/32.png) [@deon.korb](https://forum.inductiveautomation.com/u/deon.korb)\
**Post date:** [March 24, 2026, 1:14pm UTC](https://forum.inductiveautomation.com/t/system-perspective-alterdock-params/114641/3 "2026-03-24T13:14:45Z")

</div>

I don’t simply want to open it. I want to ensure it remains open until auto is an option again. Closing and opening is not a suitable option.

---

<div class="post-metadata">

**Author:** ![Nol](https://avatars.discourse-cdn.com/v4/letter/n/8e8cbc/32.png) [@Nol](https://forum.inductiveautomation.com/u/Nol)\
**Post date:** [March 24, 2026, 3:12pm UTC](https://forum.inductiveautomation.com/t/system-perspective-alterdock-params/114641/4 "2026-03-24T15:12:15Z")

</div>

The options for display are the push/cover/auto. Unless it's missing from the documentation I don't know if you can change ondemand to visible during runtime.

> **[system.perspective.alterDock | Ignition User Manual](https://www.docs.inductiveautomation.com/docs/8.1/appendix/scripting-functions/system-perspective/system-perspective-alterDock)**
>
> Changes configuration of a specified dock on a Perspective page.

---

<div class="post-metadata">

**Author:** ![deon.korb](https://avatars.discourse-cdn.com/v4/letter/d/8c91f0/32.png) [@deon.korb](https://forum.inductiveautomation.com/u/deon.korb)\
**Post date:** [March 25, 2026, 5:58am UTC](https://forum.inductiveautomation.com/t/system-perspective-alterdock-params/114641/5 "2026-03-25T05:58:11Z")

</div>

That was my point.

GUI options for display are visible/onDemand/auto. Docs function options for display are push/cover/auto.

GUI options for content are push/cover/auto. It is entire omitted/conflated with display in the docs.

Is it possible to alter the display visible/onDemand/auto options programmatically?

---

<div class="post-metadata">

**Author:** ![deon.korb](https://avatars.discourse-cdn.com/v4/letter/d/8c91f0/32.png) [@deon.korb](https://forum.inductiveautomation.com/u/deon.korb)\
**Post date:** [March 25, 2026, 9:41am UTC](https://forum.inductiveautomation.com/t/system-perspective-alterdock-params/114641/6 "2026-03-25T09:41:26Z")

</div>

I solved it like this:

```python
		if not currentValue.value:	
			#Permanently show the dock
			config = {"display":"visible","handle":"hide"}
			system.perspective.alterDock(	dockId = dockId, \
											config = config,\
											pageId = pageId)
			system.perspective.openDock(id = dockId)
		else:
			#Hide and allow manual show
			config = {"display":"onDemand","handle":"show"}
			system.perspective.alterDock(	dockId = dockId, \
											config = config,\
											pageId = pageId)
			system.perspective.closeDock(id = dockId)

```

Feels clunky, but it works

---

<div class="post-metadata">

**Author:** ![Bushmatic](https://sea1.discourse-cdn.com/inductiveautomation/user_avatar/forum.inductiveautomation.com/bushmatic/32/87014_2.png) [@Bushmatic](https://forum.inductiveautomation.com/u/Bushmatic)\
**Post date:** [March 25, 2026, 3:35pm UTC](https://forum.inductiveautomation.com/t/system-perspective-alterdock-params/114641/7 "2026-03-25T15:35:38Z")

</div>

I noticed yesterday myself that the documentation for `system.perspective.alterDock` is wrong for the display settings. I was making a lock/unlock feature for a dock with similar logic to @deon.korb’s script. See the end of this post:

> [@Dock Parameters Resetting between each page](https://forum.inductiveautomation.com/t/dock-parameters-resetting-between-each-page/76160/7):
>
> What about having dock parameters/configurations persist when opening new pages with the same dock configuration? This thread is regarding that issue, not the topic of altering multiple docks at once. My issue is very similar to @Michael_White’s. I have a simple button to show/autoHide the dock (among other configuration changes, including content, modal, handle…) using system.perspective.alterDock(). Default is autoHide. When clicking a link in the docked view to navigate to a new page (but wi…
