Class Actions

constructor

• new Actions(): Actions

• Returns Actions

Static ADD_NODE

Static ADJUST_BORDER_SPLIT

Static ADJUST_SPLIT

Static DELETE_TAB

Static DELETE_TABSET

Static FLOAT_TAB

Static MAXIMIZE_TOGGLE

Static MOVE_NODE

Static RENAME_TAB

Static SELECT_TAB

Static SET_ACTIVE_TABSET

Static UNFLOAT_TAB

Static UPDATE_MODEL_ATTRIBUTES

Static UPDATE_NODE_ATTRIBUTES

Static addNode

• addNode(json, toNodeId, location, index, select?): Action

• Adds a tab node to the given tabset node

  Returns

  the action

  Parameters

  • json: any

    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.

  • Optional select: boolean

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

  Returns Action

Static adjustBorderSplit

• adjustBorderSplit(nodeId, pos): Action

• Parameters

  • nodeId: string

  • pos: number

  Returns Action

Static adjustSplit

• adjustSplit(splitSpec): Action

• Adjust the splitter between two tabsets

  Example

  Actions.adjustSplit({node1: "1", weight1:30, pixelWidth1:300, node2: "2", weight2:70, pixelWidth2:700});
  

  Returns

  the action

  Parameters

  • splitSpec: {
        node1Id: string;
        node2Id: string;
        pixelWidth1: number;
        pixelWidth2: number;
        weight1: number;
        weight2: number;
    }

    an object the defines the new split between two tabsets, see example below.

    • node1Id: string

    • node2Id: string

    • pixelWidth1: number

    • pixelWidth2: number

    • weight1: number

    • weight2: number

  Returns Action

Static deleteTab

• deleteTab(tabNodeId): Action

• Deletes a tab node from the layout

  Returns

  the action

  Parameters

  • tabNodeId: string

  Returns Action

Static deleteTabset

• deleteTabset(tabsetNodeId): Action

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

  Returns

  the action

  Parameters

  • tabsetNodeId: string

    the id of the tabset node to delete

  Returns Action

Static floatTab

• floatTab(nodeId): Action

• Parameters

  • nodeId: string

  Returns Action

Static maximizeToggle

• maximizeToggle(tabsetNodeId): Action

• Maximizes the given tabset

  Returns

  the action

  Parameters

  • tabsetNodeId: string

    the id of the tabset to maximize

  Returns Action

Static moveNode

• moveNode(fromNodeId, toNodeId, location, index, select?): Action

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

  Returns

  the action

  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.

  • Optional select: boolean

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

  Returns Action

Static renameTab

• renameTab(tabNodeId, text): Action

• Change the given nodes tab text

  Returns

  the action

  Parameters

  • tabNodeId: string

    the id of the node to rename

  • text: string

    the test of the tab

  Returns Action

Static selectTab

• selectTab(tabNodeId): Action

• Selects the given tab in its parent tabset

  Returns

  the action

  Parameters

  • tabNodeId: string

    the id of the node to set selected

  Returns Action

Static setActiveTabset

• setActiveTabset(tabsetNodeId): Action

• Set the given tabset node as the active tabset

  Returns

  the action

  Parameters

  • tabsetNodeId: undefined | string

    the id of the tabset node to set as active

  Returns Action

Static unFloatTab

• unFloatTab(nodeId): Action

• Parameters

  • nodeId: string

  Returns Action

Static updateModelAttributes

• updateModelAttributes(attributes): Action

• Updates the global model jsone attributes

  Returns

  the action

  Parameters

  • attributes: any

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

  Returns Action

Static updateNodeAttributes

• updateNodeAttributes(nodeId, attributes): Action

• Updates the given nodes json attributes

  Returns

  the action

  Parameters

  • nodeId: string

    the id of the node to update

  • attributes: any

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

  Returns Action