Skip to contents

Dockview edge group operations

Source: R/proxy.R
edge-group-proxy.Rd

Manipulate edge groups, that is groups pinned to one of the four edges of a dock, from the server. See https://dockview.dev/docs/core/groups/edgeGroups.

Usage

add_edge_group(dock, edge_group)

remove_edge_group(dock, position)

set_edge_group_collapsed(dock, position, collapsed)

set_edge_group_visible(dock, position, visible)

set_edge_group_size(dock, position, size)

Arguments

dock

Dock proxy object created with dock_view_proxy().

edge_group

An edge group object created with edge_group().

position

Edge position. One of "left", "right", "top", "bottom".

collapsed

Whether the edge group should be collapsed.

visible

Whether the edge group should be visible.

size

Target size of the edge group, as a fraction between 0 and 1 of the dock's width (left and right rails) or height (top and bottom ones).

Value

All functions return the dock proxy object invisibly, so they can be chained.

Details

  • add_edge_group(): pins a new edge group to the requested edge.

  • remove_edge_group(): removes the edge group pinned to position, disposing of the panels it holds.

  • set_edge_group_visible(): shows or hides the edge group at position without removing it. An invisible rail renders at zero and keeps whatever collapsed state it had.

  • set_edge_group_collapsed(): collapses the edge group at position to its collapsed_size, or expands it again. A collapsed rail keeps its header strip standing, which is what distinguishes it from an invisible one. This is the server-side equivalent of the user gesture, a click on the rail's active tab.

    It is the only route to the collapsed state of a dock that is already running. The state can also be declared two other ways, neither of which needs this: edge_group(collapsed = TRUE) at construction, and the edgeGroups entry of a payload handed to restore_dock(), which carries collapsed beside size and visible and is honoured on restore.

  • set_edge_group_size(): resizes the edge group at position along its own axis, to size of the dock: of its width for a "left" or "right" rail, of its height for a "top" or "bottom" one. A fraction rather than pixels, as for set_size(), since the server does not know how large the dock is. It is converted to pixels when the call lands, and the rail then holds that width as the dock resizes, as rails do. dockview clamps it to the rail's minimum_size / maximum_size and to the space available. On a collapsed rail the size is the one it expands to.

Read either state back with is_edge_group_visible() and is_edge_group_collapsed(), and the size, in pixels, from get_edge_groups().

See also

edge_group(), is_edge_group_visible(), is_edge_group_collapsed()