Class Actions

constructor

• new Actions(): Actions

  Returns Actions

StaticADD_TAB

StaticADJUST_BORDER_SPLIT

StaticADJUST_WEIGHTS

StaticCLOSE_POPOUT

StaticCREATE_SUBLAYOUT

StaticDELETE_TAB

StaticDELETE_TABSET

StaticMAXIMIZE_TOGGLE

StaticMOVE_NODE

StaticMOVE_POPOUT_TO_FRONT

StaticPOPOUT_TAB

StaticPOPOUT_TABSET

StaticRENAME_TAB

StaticSELECT_TAB

StaticSET_ACTIVE_TABSET

StaticSET_BORDER_TYPE

StaticSET_TAB_PINNED

StaticUPDATE_MODEL_ATTRIBUTES

StaticUPDATE_NODE_ATTRIBUTES

StaticaddNode

• addNode(
      json: ITabAttributes,
      toNodeId: string,
      location: DockLocation,
      index: number,
      select?: boolean,
  ): Action

  Parameters

  • json: ITabAttributes
  • toNodeId: string
  • location: DockLocation
  • index: number
  • Optionalselect: boolean

  Returns Action

  Deprecated

  use 'addTab' instead

StaticaddTab

• addTab(
      json: ITabAttributes,
      toNodeId: string,
      location: DockLocation,
      index: number,
      select?: boolean,
  ): Action

  Adds a tab node to the given tabset node

  Parameters

  • json: ITabAttributes

    the json for the new tab node e.g {type:"tab", component:"table"}

  • toNodeId: string

    the new tab node will be added to the tabset with this node id

  • location: DockLocation

    the location where the new tab will be added, one of the DockLocation enum values.

  • index: number

    for docking to the center this value is the index of the tab, use -1 to add to the end.

  • Optionalselect: boolean

    (optional) whether to select the new tab, overriding autoSelectTab

  Returns Action

  the action

StaticadjustBorderSplit

• adjustBorderSplit(nodeId: string, size: number): Action

  Adjust the size of the border

  Parameters

  • nodeId: string

    the id of the border node to adjust

  • size: number

    the new border size

  Returns Action

  the action

StaticadjustWeights

• adjustWeights(nodeId: string, weights: number[]): Action

  Adjust the weights of a row, used when the splitter is moved

  Parameters

  • nodeId: string

    the id of the row node whose childrens weights are being adjusted

  • weights: number[]

    an array of weights to be applied to the children

  Returns Action

  the action

StaticclosePopout

• closePopout(layoutId: string): Action

  Closes the popout

  Parameters

  • layoutId: string

    the id of the popout to close

  Returns Action

  the action

StaticcreatePopout

• createPopout(layout: IJsonRowNode, rect: IJsonRect, type: ILayoutType): Action

  Creates a new empty popout window with the given layout (alias for createSubLayout)

  Parameters

  • layout: IJsonRowNode

    the json layout for the new window

  • rect: IJsonRect

    the window rectangle in screen coordinates

  • type: ILayoutType

    the type of the popout either "window", "float"

  Returns Action

  the action

StaticcreateSubLayout

• createSubLayout(
      layout: IJsonRowNode,
      rect: IJsonRect,
      type: ILayoutType,
  ): Action

  Creates a new sublayout with the given layout

  Parameters

  • layout: IJsonRowNode

    the json layout for the new window

  • rect: IJsonRect

    the window rectangle in screen coordinates

  • type: ILayoutType

    the type of the sublayout either "window", "float" or "tab"

  Returns Action

  the action

StaticdeleteTab

• deleteTab(tabNodeId: string): Action

  Deletes a tab node from the layout

  Parameters

  • tabNodeId: string

    the id of the tab node to delete

  Returns Action

  the action

StaticdeleteTabset

• deleteTabset(tabsetNodeId: string): Action

  Deletes a tabset node and all it's child tab nodes from the layout

  Parameters

  • tabsetNodeId: string

    the id of the tabset node to delete

  Returns Action

  the action

StaticmaximizeToggle

• maximizeToggle(tabsetNodeId: string, layoutId?: string): Action

  Maximizes the given tabset

  Parameters

  • tabsetNodeId: string

    the id of the tabset to maximize

  • OptionallayoutId: string

  Returns Action

  the action

StaticmoveNode

• moveNode(
      fromNodeId: string,
      toNodeId: string,
      location: DockLocation,
      index: number,
      select?: boolean,
  ): Action

  Moves a node (tab or tabset) from one location to another

  Parameters

  • fromNodeId: string

    the id of the node to move

  • toNodeId: string

    the id of the node to receive the moved node

  • location: DockLocation

    the location where the moved node will be added, one of the DockLocation enum values.

  • index: number

    for docking to the center this value is the index of the tab, use -1 to add to the end.

  • Optionalselect: boolean

    (optional) whether to select the moved tab(s) in new tabset, overriding autoSelectTab

  Returns Action

  the action

StaticmovePopoutToFront

• movePopoutToFront(layoutId: string): Action

  Moves a floating panel popout to the front of the display

  Parameters

  • layoutId: string

    the id of the floating panel popout to move

  Returns Action

  the action

StaticpopoutTab

• popoutTab(nodeId: string, type?: ILayoutType): Action

  Pops out the given tab node into a new browser window or floating panel

  Parameters

  • nodeId: string

    the tab node to popout

  • type: ILayoutType = "window"

    the type of window to create, either "window" (native browser window) or "float" (simulated div based window)

  Returns Action

  the action

StaticpopoutTabset

• popoutTabset(nodeId: string, type?: ILayoutType): Action

  Pops out the given tabset node into a new browser window or floating panel

  Parameters

  • nodeId: string

    the tabset node to popout

  • type: ILayoutType = "window"

    the type of window to create, either "window" (native browser window) or "float" (simulated div based window)

  Returns Action

  the action

StaticrenameTab

• renameTab(tabNodeId: string, text: string): Action

  Change the given nodes tab text

  Parameters

  • tabNodeId: string

    the id of the tab node to rename

  • text: string

    the test of the tab

  Returns Action

  the action

StaticselectTab

• selectTab(tabNodeId: string): Action

  Selects the given tab in its parent tabset

  Parameters

  • tabNodeId: string

    the id of the tab node to set selected

  Returns Action

  the action

StaticsetActiveTabset

• setActiveTabset(tabsetNodeId: string | undefined, layoutId?: string): Action

  Set the given tabset node as the active tabset

  Parameters

  • tabsetNodeId: string | undefined

    the id of the tabset node to set as active

  • OptionallayoutId: string

  Returns Action

  the action

StaticsetBorderType

• setBorderType(borderNodeId: string, borderType: "split" | "overlay"): Action

  Sets the display type of the given border. In 'overlay' mode the selected tab's panel overlays the main layout area instead of insetting it (Visual Studio style auto hide), and is deselected by a pointer-down in the main layout area.

  Parameters

  • borderNodeId: string

    the id of the border node (border ids are "border_" + location, e.g. "border_left")

  • borderType: "split" | "overlay"

    the new border type

  Returns Action

  the action

StaticsetTabPinned

• setTabPinned(tabNodeId: string, pinned: boolean): Action

  Pins or unpins the given tab; pinning moves it to the end of the pinned group at the start of its tabset's tabstrip, unpinning moves it to the start of the unpinned tabs. Only applies to tabs in tabsets (ignored for border tabs).

  Parameters

  • tabNodeId: string

    the id of the tab node to pin/unpin

  • pinned: boolean

    the new pinned state

  Returns Action

  the action

StaticupdateModelAttributes

• updateModelAttributes(attributes: IGlobalAttributes): Action

  Updates the global model jsone attributes

  Parameters

  • attributes: IGlobalAttributes

    the json for the model attributes to update (merge into the existing attributes)

  Returns Action

  the action

StaticupdateNodeAttributes

• updateNodeAttributes(
      nodeId: string,
      attributes: IRowAttributes | ITabAttributes | ITabSetAttributes,
  ): Action

  Updates the given nodes json attributes

  Parameters

  • nodeId: string

    the id of the node to update

  • attributes: IRowAttributes | ITabAttributes | ITabSetAttributes

    the json attributes to update (merge with the existing attributes)

  Returns Action

  the action