ShuffleboardContainer

class wpilib.shuffleboard.ShuffleboardContainer

Bases: ShuffleboardValue

Common interface for objects that can contain shuffleboard components.

add(*args, **kwargs)

Overloaded function.

1. add(self: wpilib.shuffleboard._shuffleboard.ShuffleboardContainer, title: str, defaultValue: wpiutil._wpiutil.Sendable) -> wpilib.shuffleboard._shuffleboard.ComplexWidget

Adds a widget to this container to display the given sendable.

Parameters:

• title – the title of the widget

• defaultValue – the sendable to display

Returns:

a widget to display the sendable data @throws IllegalArgumentException if a widget already exists in this container with the given title

2. add(self: wpilib.shuffleboard._shuffleboard.ShuffleboardContainer, defaultValue: wpiutil._wpiutil.Sendable) -> wpilib.shuffleboard._shuffleboard.ComplexWidget

Adds a widget to this container to display the given sendable.

Parameters:

defaultValue – the sendable to display

Returns:

a widget to display the sendable data @throws IllegalArgumentException if a widget already exists in this container with the given title, or if the sendable’s name has not been specified

3. add(self: wpilib.shuffleboard._shuffleboard.ShuffleboardContainer, title: str, defaultValue: ntcore._ntcore.Value) -> wpilib.shuffleboard._shuffleboard.SimpleWidget

Adds a widget to this container to display the given data.

Parameters:

• title – the title of the widget

• defaultValue – the default value of the widget

Returns:

a widget to display the sendable data @throws IllegalArgumentException if a widget already exists in this container with the given title @see AddPersistent(std::string_view, std::shared_ptr<nt::Value>) Add(std::string_view title, std::shared_ptr<nt::Value> defaultValue)

4. add(self: wpilib.shuffleboard._shuffleboard.ShuffleboardContainer, title: str, defaultValue: bool) -> wpilib.shuffleboard._shuffleboard.SimpleWidget

Adds a widget to this container to display the given data.

Parameters:

• title – the title of the widget

• defaultValue – the default value of the widget

Returns:

a widget to display the sendable data @throws IllegalArgumentException if a widget already exists in this container with the given title @see AddPersistent(std::string_view, bool) Add(std::string_view title, bool defaultValue)

5. add(self: wpilib.shuffleboard._shuffleboard.ShuffleboardContainer, title: str, defaultValue: float) -> wpilib.shuffleboard._shuffleboard.SimpleWidget

Adds a widget to this container to display the given data.

Parameters:

• title – the title of the widget

• defaultValue – the default value of the widget

Returns:

a widget to display the sendable data @throws IllegalArgumentException if a widget already exists in this container with the given title @see AddPersistent(std::string_view, double) Add(std::string_view title, double defaultValue)

6. add(self: wpilib.shuffleboard._shuffleboard.ShuffleboardContainer, title: str, defaultValue: float) -> wpilib.shuffleboard._shuffleboard.SimpleWidget

Adds a widget to this container to display the given data.

Parameters:

• title – the title of the widget

• defaultValue – the default value of the widget

Returns:

a widget to display the sendable data @throws IllegalArgumentException if a widget already exists in this container with the given title @see AddPersistent(std::string_view, double) Add(std::string_view title, double defaultValue)

7. add(self: wpilib.shuffleboard._shuffleboard.ShuffleboardContainer, title: str, defaultValue: int) -> wpilib.shuffleboard._shuffleboard.SimpleWidget

Adds a widget to this container to display the given data.

Parameters:

• title – the title of the widget

• defaultValue – the default value of the widget

Returns:

a widget to display the sendable data @throws IllegalArgumentException if a widget already exists in this container with the given title @see AddPersistent(std::string_view, int) Add(std::string_view title, int defaultValue)

8. add(self: wpilib.shuffleboard._shuffleboard.ShuffleboardContainer, title: str, defaultValue: str) -> wpilib.shuffleboard._shuffleboard.SimpleWidget

Adds a widget to this container to display the given data.

Parameters:

• title – the title of the widget

• defaultValue – the default value of the widget

Returns:

a widget to display the sendable data @throws IllegalArgumentException if a widget already exists in this container with the given title @see AddPersistent(std::string_view, std::string_view) Add(std::string_view title, std::string_view defaultValue)

9. add(self: wpilib.shuffleboard._shuffleboard.ShuffleboardContainer, title: str, defaultValue: List[bool]) -> wpilib.shuffleboard._shuffleboard.SimpleWidget

Adds a widget to this container to display the given data.

Parameters:

• title – the title of the widget

• defaultValue – the default value of the widget

Returns:

a widget to display the sendable data @throws IllegalArgumentException if a widget already exists in this container with the given title @see AddPersistent(std::string_view, std::span<const bool>) Add(std::string_view title, std::span<const bool> defaultValue)

10. add(self: wpilib.shuffleboard._shuffleboard.ShuffleboardContainer, title: str, defaultValue: List[float]) -> wpilib.shuffleboard._shuffleboard.SimpleWidget

Adds a widget to this container to display the given data.

Parameters:

• title – the title of the widget

• defaultValue – the default value of the widget

Returns:

a widget to display the sendable data @throws IllegalArgumentException if a widget already exists in this container with the given title @see AddPersistent(std::string_view, std::span<const double>) Add(std::string_view title, std::span<const double> defaultValue)

11. add(self: wpilib.shuffleboard._shuffleboard.ShuffleboardContainer, title: str, defaultValue: List[float]) -> wpilib.shuffleboard._shuffleboard.SimpleWidget

Adds a widget to this container to display the given data.

Parameters:

• title – the title of the widget

• defaultValue – the default value of the widget

Returns:

a widget to display the sendable data @throws IllegalArgumentException if a widget already exists in this container with the given title @see AddPersistent(std::string_view, std::span<const double>) Add(std::string_view title, std::span<const double> defaultValue)

12. add(self: wpilib.shuffleboard._shuffleboard.ShuffleboardContainer, title: str, defaultValue: List[int]) -> wpilib.shuffleboard._shuffleboard.SimpleWidget

Adds a widget to this container to display the given data.

Parameters:

• title – the title of the widget

• defaultValue – the default value of the widget

Returns:

a widget to display the sendable data @throws IllegalArgumentException if a widget already exists in this container with the given title @see AddPersistent(std::string_view, std::span<const double>) Add(std::string_view title, std::span<const double> defaultValue)

13. add(self: wpilib.shuffleboard._shuffleboard.ShuffleboardContainer, title: str, defaultValue: List[str]) -> wpilib.shuffleboard._shuffleboard.SimpleWidget

Adds a widget to this container to display the given data.

Parameters:

• title – the title of the widget

• defaultValue – the default value of the widget

Returns:

a widget to display the sendable data @throws IllegalArgumentException if a widget already exists in this container with the given title @see AddPersistent(std::string_view, std::span<const std::string>) Add(std::string_view title, std::span<const std::string> defaultValue)

addBoolean(title: str, supplier: Callable[[], bool]) → wpilib.shuffleboard._shuffleboard.SuppliedBoolValueWidget

Adds a widget to this container. The widget will display the data provided by the value supplier. Changes made on the dashboard will not propagate to the widget object, and will be overridden by values from the value supplier.

Parameters:

• title – the title of the widget

• supplier – the supplier for values

Returns:

a widget to display data

addBooleanArray(title: str, supplier: Callable[[], list[int]]) → wpilib.shuffleboard._shuffleboard.SuppliedBoolListValueWidget

Adds a widget to this container. The widget will display the data provided by the value supplier. Changes made on the dashboard will not propagate to the widget object, and will be overridden by values from the value supplier.

Parameters:

• title – the title of the widget

• supplier – the supplier for values

Returns:

a widget to display data

addDouble(title: str, supplier: Callable[[], float]) → wpilib.shuffleboard._shuffleboard.SuppliedDoubleValueWidget

Adds a widget to this container. The widget will display the data provided by the value supplier. Changes made on the dashboard will not propagate to the widget object, and will be overridden by values from the value supplier.

Parameters:

• title – the title of the widget

• supplier – the supplier for values

Returns:

a widget to display data

addDoubleArray(title: str, supplier: Callable[[], list[float]]) → wpilib.shuffleboard._shuffleboard.SuppliedDoubleListValueWidget

Adds a widget to this container. The widget will display the data provided by the value supplier. Changes made on the dashboard will not propagate to the widget object, and will be overridden by values from the value supplier.

Parameters:

• title – the title of the widget

• supplier – the supplier for values

Returns:

a widget to display data

addFloat(title: str, supplier: Callable[[], float]) → wpilib.shuffleboard._shuffleboard.SuppliedFloatValueWidget

Adds a widget to this container. The widget will display the data provided by the value supplier. Changes made on the dashboard will not propagate to the widget object, and will be overridden by values from the value supplier.

Parameters:

• title – the title of the widget

• supplier – the supplier for values

Returns:

a widget to display data

addFloatArray(title: str, supplier: Callable[[], list[float]]) → wpilib.shuffleboard._shuffleboard.SuppliedFloatListValueWidget

Adds a widget to this container. The widget will display the data provided by the value supplier. Changes made on the dashboard will not propagate to the widget object, and will be overridden by values from the value supplier.

Parameters:

• title – the title of the widget

• supplier – the supplier for values

Returns:

a widget to display data

addInteger(title: str, supplier: Callable[[], int]) → wpilib.shuffleboard._shuffleboard.SuppliedIntegerValueWidget

Adds a widget to this container. The widget will display the data provided by the value supplier. Changes made on the dashboard will not propagate to the widget object, and will be overridden by values from the value supplier.

Parameters:

• title – the title of the widget

• supplier – the supplier for values

Returns:

a widget to display data

addIntegerArray(title: str, supplier: Callable[[], list[int]]) → wpilib.shuffleboard._shuffleboard.SuppliedIntListValueWidget

Adds a widget to this container. The widget will display the data provided by the value supplier. Changes made on the dashboard will not propagate to the widget object, and will be overridden by values from the value supplier.

Parameters:

• title – the title of the widget

• supplier – the supplier for values

Returns:

a widget to display data

addNumber(title: str, supplier: Callable[[], float]) → wpilib.shuffleboard._shuffleboard.SuppliedDoubleValueWidget

Adds a widget to this container. The widget will display the data provided by the value supplier. Changes made on the dashboard will not propagate to the widget object, and will be overridden by values from the value supplier.

Parameters:

• title – the title of the widget

• supplier – the supplier for values

Returns:

a widget to display data

addNumberArray(title: str, supplier: Callable[[], list[float]]) → wpilib.shuffleboard._shuffleboard.SuppliedDoubleListValueWidget

Adds a widget to this container. The widget will display the data provided by the value supplier. Changes made on the dashboard will not propagate to the widget object, and will be overridden by values from the value supplier.

Parameters:

• title – the title of the widget

• supplier – the supplier for values

Returns:

a widget to display data

addPersistent(*args, **kwargs)

Overloaded function.

1. addPersistent(self: wpilib.shuffleboard._shuffleboard.ShuffleboardContainer, title: str, defaultValue: ntcore._ntcore.Value) -> wpilib.shuffleboard._shuffleboard.SimpleWidget

Adds a widget to this container to display a simple piece of data.

Unlike Add(std::string_view, std::shared_ptr<nt::Value>), the value in the widget will be saved on the robot and will be used when the robot program next starts rather than defaultValue.

Parameters:

• title – the title of the widget

• defaultValue – the default value of the widget

Returns:

a widget to display the sendable data @see Add(stdd::string_view, std::shared_ptr<nt::Value>) Add(std::string_view title, std::shared_ptr<nt::Value> defaultValue)

2. addPersistent(self: wpilib.shuffleboard._shuffleboard.ShuffleboardContainer, title: str, defaultValue: bool) -> wpilib.shuffleboard._shuffleboard.SimpleWidget

Adds a widget to this container to display a simple piece of data.

Unlike Add(std::string_view, bool), the value in the widget will be saved on the robot and will be used when the robot program next starts rather than defaultValue.

Parameters:

• title – the title of the widget

• defaultValue – the default value of the widget

Returns:

a widget to display the sendable data @see Add(std::string_view, bool) Add(std::string_view title, bool defaultValue)

3. addPersistent(self: wpilib.shuffleboard._shuffleboard.ShuffleboardContainer, title: str, defaultValue: float) -> wpilib.shuffleboard._shuffleboard.SimpleWidget

Adds a widget to this container to display a simple piece of data.

Unlike Add(std::string_view, double), the value in the widget will be saved on the robot and will be used when the robot program next starts rather than defaultValue.

Parameters:

• title – the title of the widget

• defaultValue – the default value of the widget

Returns:

a widget to display the sendable data @see Add(std::string_view, double) Add(std::string_view title, double defaultValue)

4. addPersistent(self: wpilib.shuffleboard._shuffleboard.ShuffleboardContainer, title: str, defaultValue: float) -> wpilib.shuffleboard._shuffleboard.SimpleWidget

Adds a widget to this container to display a simple piece of data.

Unlike Add(std::string_view, float), the value in the widget will be saved on the robot and will be used when the robot program next starts rather than defaultValue.

Parameters:

• title – the title of the widget

• defaultValue – the default value of the widget

Returns:

a widget to display the sendable data @see Add(std::string_view, float) Add(std::string_view title, float defaultValue)

5. addPersistent(self: wpilib.shuffleboard._shuffleboard.ShuffleboardContainer, title: str, defaultValue: int) -> wpilib.shuffleboard._shuffleboard.SimpleWidget

Adds a widget to this container to display a simple piece of data.

Unlike Add(std::string_view, int64_t), the value in the widget will be saved on the robot and will be used when the robot program next starts rather than defaultValue.

Parameters:

• title – the title of the widget

• defaultValue – the default value of the widget

Returns:

a widget to display the sendable data @see Add(std:string_view, int64_t) Add(std::string_view title, int64_t defaultValue)

6. addPersistent(self: wpilib.shuffleboard._shuffleboard.ShuffleboardContainer, title: str, defaultValue: str) -> wpilib.shuffleboard._shuffleboard.SimpleWidget

Adds a widget to this container to display a simple piece of data.

Unlike Add(std::string_view, std::string_view), the value in the widget will be saved on the robot and will be used when the robot program next starts rather than defaultValue.

Parameters:

• title – the title of the widget

• defaultValue – the default value of the widget

Returns:

a widget to display the sendable data @see Add(std::string_view, std::string_view) Add(std::string_view title, std::string_view defaultValue)

7. addPersistent(self: wpilib.shuffleboard._shuffleboard.ShuffleboardContainer, title: str, defaultValue: List[bool]) -> wpilib.shuffleboard._shuffleboard.SimpleWidget

Adds a widget to this container to display a simple piece of data.

Unlike Add(std::string_view, std::span<const bool>), the value in the widget will be saved on the robot and will be used when the robot program next starts rather than defaultValue.

Parameters:

• title – the title of the widget

• defaultValue – the default value of the widget

Returns:

a widget to display the sendable data @see Add(std::string_view, std::span<const bool>) Add(std::string_view title, std::span<const bool> defaultValue)

8. addPersistent(self: wpilib.shuffleboard._shuffleboard.ShuffleboardContainer, title: str, defaultValue: List[float]) -> wpilib.shuffleboard._shuffleboard.SimpleWidget

Adds a widget to this container to display a simple piece of data.

Unlike Add(std::string_view, std::span<const double>), the value in the widget will be saved on the robot and will be used when the robot program next starts rather than defaultValue.

Parameters:

• title – the title of the widget

• defaultValue – the default value of the widget

Returns:

a widget to display the sendable data @see Add(std::string_view, std::span<const double>) Add(std::string_view title, std::span<const double> defaultValue)

9. addPersistent(self: wpilib.shuffleboard._shuffleboard.ShuffleboardContainer, title: str, defaultValue: List[float]) -> wpilib.shuffleboard._shuffleboard.SimpleWidget

Adds a widget to this container to display a simple piece of data.

Unlike Add(std::string_view, std::span<const float>), the value in the widget will be saved on the robot and will be used when the robot program next starts rather than defaultValue.

Parameters:

• title – the title of the widget

• defaultValue – the default value of the widget

Returns:

a widget to display the sendable data @see Add(std::string_view, std::span<const float>) Add(std::string_view title, std::span<const float> defaultValue)

10. addPersistent(self: wpilib.shuffleboard._shuffleboard.ShuffleboardContainer, title: str, defaultValue: List[int]) -> wpilib.shuffleboard._shuffleboard.SimpleWidget

Adds a widget to this container to display a simple piece of data.

Unlike Add(std::string_view, std::span<const int64_t>), the value in the widget will be saved on the robot and will be used when the robot program next starts rather than defaultValue.

Parameters:

• title – the title of the widget

• defaultValue – the default value of the widget

Returns:

a widget to display the sendable data @see Add(std::string_view, std::span<const int64_t>) Add(std::string_view title, std::span<const int64_t> defaultValue)

11. addPersistent(self: wpilib.shuffleboard._shuffleboard.ShuffleboardContainer, title: str, defaultValue: List[str]) -> wpilib.shuffleboard._shuffleboard.SimpleWidget

Adds a widget to this container to display a simple piece of data.

Unlike Add(std::string_view, std::span<const std::string>), the value in the widget will be saved on the robot and will be used when the robot program next starts rather than defaultValue.

Parameters:

• title – the title of the widget

• defaultValue – the default value of the widget

Returns:

a widget to display the sendable data @see Add(std::string_view, std::span<const std::string>) Add(std::string_view title, std::span<const std::string> defaultValue)

addRaw(*args, **kwargs)

Overloaded function.

1. addRaw(self: wpilib.shuffleboard._shuffleboard.ShuffleboardContainer, title: str, supplier: Callable[[], list[int]]) -> wpilib.shuffleboard._shuffleboard.SuppliedRawValueWidget

Adds a widget to this container. The widget will display the data provided by the value supplier. Changes made on the dashboard will not propagate to the widget object, and will be overridden by values from the value supplier.

Parameters:

• title – the title of the widget

• supplier – the supplier for values

Returns:

a widget to display data

2. addRaw(self: wpilib.shuffleboard._shuffleboard.ShuffleboardContainer, title: str, typeString: str, supplier: Callable[[], list[int]]) -> wpilib.shuffleboard._shuffleboard.SuppliedRawValueWidget

Adds a widget to this container. The widget will display the data provided by the value supplier. Changes made on the dashboard will not propagate to the widget object, and will be overridden by values from the value supplier.

Parameters:

• title – the title of the widget

• typeString – the NT type string

• supplier – the supplier for values

Returns:

a widget to display data

addString(title: str, supplier: Callable[[], str]) → wpilib.shuffleboard._shuffleboard.SuppliedStringValueWidget

Adds a widget to this container. The widget will display the data provided by the value supplier. Changes made on the dashboard will not propagate to the widget object, and will be overridden by values from the value supplier.

Parameters:

• title – the title of the widget

• supplier – the supplier for values

Returns:

a widget to display data

addStringArray(title: str, supplier: Callable[[], list[str]]) → wpilib.shuffleboard._shuffleboard.SuppliedStringListValueWidget

Adds a widget to this container. The widget will display the data provided by the value supplier. Changes made on the dashboard will not propagate to the widget object, and will be overridden by values from the value supplier.

Parameters:

• title – the title of the widget

• supplier – the supplier for values

Returns:

a widget to display data

disableIfActuator() → None

enableIfActuator() → None

getComponents() → list[wpilib.shuffleboard._shuffleboard.ShuffleboardComponentBase]

Gets the components that are direct children of this container.

getLayout(*args, **kwargs)

Overloaded function.

1. getLayout(self: wpilib.shuffleboard._shuffleboard.ShuffleboardContainer, title: str, type: wpilib.shuffleboard._shuffleboard.BuiltInLayouts) -> wpilib.shuffleboard._shuffleboard.ShuffleboardLayout

Gets the layout with the given type and title, creating it if it does not already exist at the time this method is called.

Parameters:

• title – the title of the layout

• type – the type of the layout, eg “List” or “Grid”

Returns:

the layout

2. getLayout(self: wpilib.shuffleboard._shuffleboard.ShuffleboardContainer, title: str, type: wpilib.shuffleboard._shuffleboard.LayoutType) -> wpilib.shuffleboard._shuffleboard.ShuffleboardLayout

Gets the layout with the given type and title, creating it if it does not already exist at the time this method is called.

Parameters:

• title – the title of the layout

• type – the type of the layout, eg “List” or “Grid”

Returns:

the layout

3. getLayout(self: wpilib.shuffleboard._shuffleboard.ShuffleboardContainer, title: str, type: str) -> wpilib.shuffleboard._shuffleboard.ShuffleboardLayout

Gets the layout with the given type and title, creating it if it does not already exist at the time this method is called. Note: this method should only be used to use a layout type that is not already built into Shuffleboard. To use a layout built into Shuffleboard, use GetLayout(std::string_view, const LayoutType&) and the layouts in BuiltInLayouts.

Parameters:

• title – the title of the layout

• type – the type of the layout, eg “List Layout” or “Grid Layout”

Returns:

the layout @see GetLayout(std::string_view, const LayoutType&)

4. getLayout(self: wpilib.shuffleboard._shuffleboard.ShuffleboardContainer, title: str) -> wpilib.shuffleboard._shuffleboard.ShuffleboardLayout

Gets the already-defined layout in this container with the given title.

<pre>{@code Shuffleboard::GetTab(“Example Tab”)->getLayout(“My Layout”, &BuiltInLayouts.kList);

// Later… Shuffleboard::GetTab(“Example Tab”)->GetLayout(“My Layout”); }</pre>

Parameters:

title – the title of the layout to get

Returns:

the layout with the given title @throws if no layout has yet been defined with the given title