Enum BuiltInLayouts

java.lang.Object
java.lang.Enum<BuiltInLayouts>
edu.wpi.first.wpilibj.shuffleboard.BuiltInLayouts
All Implemented Interfaces:
LayoutType, Serializable, Comparable<BuiltInLayouts>, java.lang.constant.Constable

public enum BuiltInLayouts
extends Enum<BuiltInLayouts>
implements LayoutType
The types of layouts bundled with Shuffleboard.

 ShuffleboardLayout myList = Shuffleboard.getTab("My Tab")
   .getLayout(BuiltinLayouts.kList, "My List");
 
  • Enum Constant Details

    • kList

      public static final BuiltInLayouts kList
      Groups components in a vertical list. New widgets added to the layout will be placed at the bottom of the list.
      Custom properties:
      NameTypeDefault ValueNotes
      Label positionString"BOTTOM" The position of component labels inside the grid. One of ["TOP", "LEFT", "BOTTOM", "RIGHT", "HIDDEN"
    • kGrid

      public static final BuiltInLayouts kGrid
      Groups components in an n x m grid. Grid layouts default to 3x3.
      Custom properties:
      NameTypeDefault ValueNotes
      Number of columnsNumber3Must be in the range [1,15]
      Number of rowsNumber3Must be in the range [1,15]
      Label position String "BOTTOM" The position of component labels inside the grid. One of ["TOP", "LEFT", "BOTTOM", "RIGHT", "HIDDEN"
  • Method Details

    • values

      public static BuiltInLayouts[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared
    • valueOf

      public static BuiltInLayouts valueOf​(String name)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null
    • getLayoutName

      Description copied from interface: LayoutType
      Gets the string type of the layout as defined by that layout in Shuffleboard.
      Specified by:
      getLayoutName in interface LayoutType
      Returns:
      The string type of the layout.