Class Actions

constructor

• new Actions(): Actions

  Returns Actions

StaticADD_NODE

StaticADJUST_BORDER_SPLIT

StaticADJUST_WEIGHTS

StaticDELETE_TAB

StaticDELETE_TABSET

StaticMAXIMIZE_TOGGLE

StaticMOVE_NODE

StaticRENAME_TAB

StaticSELECT_TAB

StaticSET_ACTIVE_TABSET

StaticUPDATE_MODEL_ATTRIBUTES

StaticUPDATE_NODE_ATTRIBUTES

StaticaddNode

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

  Adds a tab node to the given tabset node

  Parameters

  • json: IJsonTabNode

    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, pos: number): Action

  Parameters

  • nodeId: string
  • pos: number

  Returns Action

StaticadjustWeights

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

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

  Parameters

  • nodeId: string

    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

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, windowId?: string): Action

  Maximizes the given tabset

  Parameters

  • tabsetNodeId: string

    the id of the tabset to maximize

  • OptionalwindowId: 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

StaticrenameTab

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

  Change the given nodes tab text

  Parameters

  • tabNodeId: string

    the id of the 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 node to set selected

  Returns Action

  the action

StaticsetActiveTabset

• setActiveTabset(tabsetNodeId: string | undefined, windowId?: 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

  • OptionalwindowId: string

  Returns Action

  the action

StaticupdateModelAttributes

• updateModelAttributes(attributes: Partial<IGlobalAttributes>): Action

  Updates the global model jsone attributes

  Parameters

  • attributes: Partial<IGlobalAttributes>

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

  Returns Action

  the action

StaticupdateNodeAttributes

• updateNodeAttributes(nodeId: string, attributes: NodeAttributes): Action

  Updates the given nodes json attributes

  Parameters

  • nodeId: string

    the id of the node to update

  • attributes: NodeAttributes

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

  Returns Action

  the action