HL.MonitorSelector

class HL.MonitorSelector

Selector accepted by monitor query functions.

HL.MonitorSelector may be a monitor name, monitor ID, or an existing HL.Monitor object.

Accepted values

valuestring

Monitor output name, such as "DP-1" or "HDMI-A-1".

valueinteger

Numeric monitor ID.

valueHL.Monitor

Existing runtime monitor object.

Examples

Select a monitor by output name:

local monitor = hl.get_monitor("DP-1")

Select a monitor by ID:

local monitor = hl.get_monitor(0)

Pass an existing monitor object:

local monitor = hl.get_active_monitor()

if monitor then
    local workspace = hl.get_active_workspace(monitor)
end

Used by

hl.get_monitor()

Get one monitor by selector.

hl.get_active_workspace()

Get the active workspace for a monitor.

hl.get_active_special_workspace()

Get the active special workspace for a monitor.

hl.get_last_workspace()

Get the last workspace for a monitor.