SeriesLegend<D> class

Series legend behavior for charts.

By default this behavior creates a legend entry per series.

Inheritance

• Object
• Legend<D>
• SeriesLegend

Constructors

SeriesLegend({SelectionModelType? selectionModelType, LegendEntryGenerator<D>? legendEntryGenerator, MeasureFormatter? measureFormatter, MeasureFormatter? secondaryMeasureFormatter, bool? showMeasures, LegendDefaultMeasure? legendDefaultMeasure, TextStyleSpec? entryTextStyle})

Properties

alwaysVisibleSeries ↔ List<String>?

Gets a list of series IDs that should always be visible.

getter/setter pair

behaviorPosition ↔ BehaviorPosition

getter/setter pair, inherited

cellPadding ↔ LegendCellPadding?

getter/setter pair, inherited

chart → BaseChart<D>

no setter, inherited

chartContext → ChartContext

no setter, inherited

componentBounds → Rectangle<int>?

Bounding box for drawing this component.

no setter, inherited

customEntryOrder ← List<String>?

no getter, inherited

defaultHiddenSeries ↔ List<String>?

Gets a list of series IDs that should be hidden by default on first chart draw.

getter/setter pair

drawAreaBounds → Rectangle<int>?

no setter, inherited

entryTextStyle ↔ TextStyleSpec?

Text style of the legend entry text.

getter/setter pair, inherited

graphicsFactory ↔ GraphicsFactory?

getter/setter pair, inherited

hashCode → int

The hash code for this object.

no setter, inherited

insideJustification ↔ InsideJustification

getter/setter pair, inherited

isAxisFlipped → bool

no setter, inherited

isRtl → bool

no setter, inherited

isSeriesRenderer → bool

Whether or not this component is a series renderer that draws series data.

no setter, inherited

layoutConfig → LayoutViewConfig

Layout params for this component.

no setter, inherited

legendDefaultMeasure ↔ LegendDefaultMeasure

Option to show measures when selection is null.

getter/setter pair

legendEntryGenerator → LegendEntryGenerator<D>

final, inherited

legendPadding ↔ LegendCellPadding?

getter/setter pair, inherited

legendState → LegendState<D>

final, inherited

legendTapHandling ↔ LegendTapHandling

Configures the behavior of the legend when the user taps/clicks on an entry. Defaults to no behavior.

getter/setter pair, inherited

measureFormatter ← MeasureFormatter?

Formatter for measure values.

no getter

outsideJustification ↔ OutsideJustification

getter/setter pair, inherited

role → String

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

secondaryMeasureFormatter ← MeasureFormatter?

Formatter for measure values of series that uses the secondary axis.

no getter

selectionModelType → SelectionModelType

final, inherited

showMeasures ↔ bool

Whether or not the legend should show measures.

getter/setter pair

showOverlaySeries ↔ bool

Whether or not the legend show overlay series.

getter/setter pair, inherited

title ↔ String

The title text to display before legend entries.

getter/setter pair, inherited

titleTextStyle ↔ TextStyleSpec?

Text style of the legend title text.

getter/setter pair, inherited

Methods

attachTo(BaseChart<D> chart) → void

Injects the behavior into a chart.

inherited

defaultLegendMeasureFormatter(num? value) → String

Default measure formatter for legends.

inherited

hideSeries(String seriesId) → void

Hides the data for a series on the chart by seriesId.

isSeriesAlwaysVisible(String seriesId) → bool

Returns whether or not a given series is always visible.

isSeriesHidden(String seriesId) → bool

Returns whether or not a given series seriesId is currently hidden.

layout(Rectangle<int> componentBounds, Rectangle<int> drawAreaBounds) → void

Layout this component.

inherited

measure(int maxWidth, int maxHeight) → ViewMeasuredSizes

Measure and return the size of this component.

inherited

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

onData(List<MutableSeries<D>> seriesList) → void

Remove series IDs from the currently hidden list if those series have been removed from the chart data. The goal is to allow any metric that is removed from a chart, and later re-added to it, to be visible to the user.

override

paint(ChartCanvas canvas, double animationPercent) → void

Draw this component on the canvas.

inherited

preProcessSeriesList(List<MutableSeries<D>> seriesList) → void

Overridable method that may be used by concrete Legend instances to manipulate the series list.

override

removeFrom(BaseChart<D> chart) → void

Removes the behavior from a chart.

inherited

showSeries(String seriesId) → void

Shows the data for a series on the chart by seriesId.

toString() → String

A string representation of this object.

inherited

updateLegend() → void

Requires override to show in native platform

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited