Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Scripting_function


New_in
Version8.1.19


Panel
titleDescription

Changes configuration of a specified dock on a Perspective Page. 

Panel
titleSyntax
Info

This function accepts keyword arguments.


system.perspective.alterDock(dockId, [dockConfig])

  • Parameters

String dockId - The ID of the dock to be altered. If no such dock exists on the current page with the given ID, a warning will be logged to the console. 

Object dockConfig - The new configuration for the dock. All properties are optional, and any properties not specified will remain unchanged. See the dockConfig Object Shape below. [optional] 

  • Returns

Nothing

  • Scope

Gateway, Perspective Session

Panel
titledockConfig Object Shape
Code Block
dockConfig {
   view: string;
   viewParams: object;
   display: enum('visible', 'onDemand', 'auto');
   resizable: boolean;
   modal: boolean;
   content: enum('push', 'cover', 'auto');
   size: number;
   autoBreakpoint: number;
   anchor: enum('fixed', 'scrollable')`;
   handle: enum('show', 'hide', 'autoHide');
   handleIcon: string;
}
Panel
titleCode Examples
Code Block
languagepy
titleCode Snippet
# Change the size of a dock with the id 'my-dock-id'
system.perspective.alterDock('my-dock-id', { "'size"': 500 } )
Panel
titleKeywords

system perspective alterDock, perspective.alterDock