BoardBackground class

The background layer of a board. Contains coloured boxes, potentially with markers.

Inheritance

Constructors

BoardBackground({Key? key, BackgroundConfig config = BackgroundConfig.standard, BoardSize size = BoardSize.standard, int orientation = Squares.white, BoardTheme theme = BoardTheme.blueGrey, Map<int, HighlightType> highlights = const {}, Map<int, Marker> markers = const {}, MarkerTheme? markerTheme})

Properties

config BackgroundConfig
Configuration for the background. Determines which squares to draw, and allows an opacity for squares to be defined.
final
hashCode int
The hash code for this object.
no setterinherited
highlights Map<int, HighlightType>
Squares that should be highlighted (i.e. have their background colour set). The key is the square index.
final
key Key?
Controls how one widget replaces another widget in the tree.
finalinherited
markers Map<int, Marker>
Squares that should be marked. The key is the square index.
final
markerTheme MarkerTheme
Widget builders for the various types of square highlights used.
latefinal
orientation int
Determines which way around the board is facing. 0 (white) will place the white pieces at the bottom, and 1 will place the black pieces there.
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
size BoardSize
Dimensions of the board.
final
theme BoardTheme
Colour scheme for the board.
final

Methods

build(BuildContext context) Widget
Describes the part of the user interface represented by this widget.
override
createElement() StatelessElement
Creates a StatelessElement to manage this widget's location in the tree.
inherited
debugDescribeChildren() List<DiagnosticsNode>
Returns a list of DiagnosticsNode objects describing this node's children.
inherited
debugFillProperties(DiagnosticPropertiesBuilder properties) → void
Add additional properties associated with the node.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toDiagnosticsNode({String? name, DiagnosticsTreeStyle? style}) DiagnosticsNode
Returns a debug representation of the object that is used by debugging tools and by DiagnosticsNode.toStringDeep.
inherited
toString({DiagnosticLevel minLevel = DiagnosticLevel.info}) String
A string representation of this object.
inherited
toStringDeep({String prefixLineOne = '', String? prefixOtherLines, DiagnosticLevel minLevel = DiagnosticLevel.debug}) String
Returns a string representation of this node and its descendants.
inherited
toStringShallow({String joiner = ', ', DiagnosticLevel minLevel = DiagnosticLevel.debug}) String
Returns a one-line detailed description of the object.
inherited
toStringShort() String
A short, textual description of this widget.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited