chessground library
Classes
- Annotation
- A chess move annotation represented by a symbol and a color.
- Arrow
- An arrow shape that can be drawn on the board.
- BoardBorder
- Describes the border of the board.
- BoardShapeWidget
- A Widget that displays a shape overlay on the Chessboard.
- BorderedChessboard
- A bordered chessboard widget.
- BrightnessHueFilter
- Change the brightness and hue of the child widget.
- CheckHighlight
- A widget that displays a check highlight.
- Chessboard
- A chessboard widget.
- ChessboardBackground
- Base widget for the background of the chessboard.
- ChessboardColorScheme
- Describes the color scheme of a ChessboardBackground.
- ChessboardEditor
- A chessboard widget where pieces can be dragged around freely (including dragging piece off and onto the board).
- ChessboardSettings
- Board settings that controls visual aspects and behavior of the board.
- ChessgroundImages
- A singleton cache for chess piece images.
- Circle
- A circle shape that can be drawn on the board.
- DrawShapeOptions
- Settings for drawing shapes on the board.
- GameData
- Game data for an interactive chessboard.
- HighlightDetails
- Square highlight color or image on the chessboard.
- ImageChessboardBackground
- A chessboard background made of an image.
- OccupiedValidMoveHighlight
- A widget that displays an occupied move destination highlight.
- PieceDragFeedback
-
The
Pieceto show under the pointer when a drag is under way. - PieceShape
- A piece shape that can be drawn on the board.
- PieceWidget
- Widget that displays a chess piece.
- Shape
- Base class for shapes that can be drawn on the board.
- SolidColorChessboardBackground
- A chessboard background with solid color squares.
- SquareHighlight
- A square highlight on the board.
- StaticChessboard
- A chessboard widget that cannot be interacted with.
- ValidMoveHighlight
- A widget that displays a valid move destination highlight.
Enums
- DragTargetKind
- Describes the kind of drag target highlighted on the board when dragging a piece.
- EditorPointerMode
- Controls the behavior of pointer events on the board editor.
- PieceOrientationBehavior
- Describes how pieces on the board are oriented.
- PieceSet
- A piece set and its corresponding piece assets.
- PieceShiftMethod
- Describes how moves are made on an interactive board.
- PlayerSide
- The side that can interact with the board.
Functions
-
premovesOf(
Square square, Pieces pieces, {bool canCastle = false}) → Set< Square> -
Returns the read-only set of squares that the piece on
squarecan potentially premove to. -
readFen(
String fen) → Pieces - Parses the board part of a FEN string.
-
writeFen(
Pieces pieces) → String - Converts the pieces to the board part of a FEN string.
Typedefs
-
PieceAssets
= IMap<
PieceKind, AssetImage> - Describes a set of piece assets.
-
Pieces
= Map<
Square, Piece> - Representation of the piece positions on a board.
- Premovable = ({void Function(NormalMove?) onSetPremove, NormalMove? premove})
- State of a premovable chessboard.
-
ValidMoves
= IMap<
Square, ISet< Square> > - Sets of each valid destinations for an origin square.