Options
All
  • Public
  • Public/Protected
  • All
Menu

Module LayoutActions

Index

Functions

MoveToRelativeZone

  • MoveToRelativeZone(__namedParameters: object): void
  • Move a region, relative to another region.

    throws

    if target or reference aren't valid IDs in the layout

    throws

    if dropping to an outer target and the reference has no parent

    Parameters

    • __namedParameters: object

    Returns void

MoveToRootZone

  • MoveToRootZone(__namedParameters: object): void
  • Move a region to the layout root

    throws

    if no region in the manager can be found with id target

    Parameters

    • __namedParameters: object

    Returns void

SurroundWith

  • SurroundWith(__namedParameters: object): string
  • Surround a layout region in-place with a new parent.

    throws

    If the target ID does not exist in the layout.

    throws

    If the target region doesn't have a parent region.

    Notes

    This won't check to see if the parent is already of the given type. That is, it will always surround with the given region. Callers that use this function automatically should first check to see that the parent is of the type they need.

    Parameters

    • __namedParameters: object

    Returns string

Generated using TypeDoc