WPILibC++ 2024.3.2
BuiltInLayouts.h
Go to the documentation of this file.
1// Copyright (c) FIRST and other WPILib contributors.
2// Open Source Software; you can modify and/or share it under the terms of
3// the WPILib BSD license file in the root directory of this project.
4
5#pragma once
6
8
9namespace frc {
10
11/**
12 * The types of layouts bundled with Shuffleboard.
13 *
14 * <pre>{@code
15 * ShuffleboardLayout myList = Shuffleboard::GetTab("My Tab")
16 * .GetLayout(BuiltinLayouts::kList, "My List");
17 * }</pre>
18 */
19enum class BuiltInLayouts {
20 /**
21 * Groups components in a vertical list. New widgets added to the layout will
22 * be placed at the bottom of the list. <br>Custom properties: <table>
23 * <tr><th>Name</th><th>Type</th><th>Default Value</th><th>Notes</th></tr>
24 * <tr><td>Label position</td><td>String</td><td>"BOTTOM"</td>
25 * <td>The position of component labels inside the grid. One of
26 * {@code ["TOP", "LEFT", "BOTTOM", "RIGHT", "HIDDEN"}</td></tr>
27 * </table>
28 */
29 kList,
30
31 /**
32 * Groups components in an <i>n</i> x <i>m</i> grid. Grid layouts default to
33 * 3x3. <br>Custom properties: <table>
34 * <tr><th>Name</th><th>Type</th><th>Default Value</th><th>Notes</th></tr>
35 * <tr><td>Number of columns</td><td>Number</td><td>3</td><td>Must be in the
36 * range [1,15]</td>
37 * </tr>
38 * <tr><td>Number of rows</td><td>Number</td><td>3</td><td>Must be in the
39 * range [1,15]</td></tr> <tr> <td>Label position</td> <td>String</td>
40 * <td>"BOTTOM"</td>
41 * <td>The position of component labels inside the grid.
42 * One of {@code ["TOP", "LEFT", "BOTTOM", "RIGHT", "HIDDEN"}</td>
43 * </tr>
44 * </table>
45 */
46 kGrid
47};
48
49} // namespace frc
Definition: AprilTagPoseEstimator.h:15
BuiltInLayouts
The types of layouts bundled with Shuffleboard.
Definition: BuiltInLayouts.h:19
@ kGrid
Groups components in an n x m grid.
@ kList
Groups components in a vertical list.