Legend class

Base widget for displaying chart legends.

A legend shows the mapping between colors/shapes and data categories, helping readers understand what different visual elements represent.

Example usage:

Legend(
  entries: [
    LegendEntry(label: 'Category A', color: Colors.blue),
    LegendEntry(label: 'Category B', color: Colors.red),
  ],
  config: LegendConfig(direction: LegendDirection.horizontal),
)

Inheritance

• Object
• DiagnosticableTree
• Widget
• StatelessWidget
• Legend

Constructors

Legend({Key? key, required List<LegendEntry> entries, LegendConfig config = const LegendConfig(), void onTap(LegendEntry entry, int index)?})

Creates a legend.

const

Properties

config → LegendConfig

Configuration for the legend.

final

entries → List<LegendEntry>

The legend entries to display.

final

hashCode → int

The hash code for this object.

no setter, inherited

key → Key?

Controls how one widget replaces another widget in the tree.

final, inherited

onTap → void Function(LegendEntry entry, int index)?

Callback when an entry is tapped.

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

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, int wrapWidth = 65}) → 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