SeriesCalloutConfig class

Global policy and styling for collision-aware series label callouts.

Callouts are disabled by default. When enabled, every supported visible series participates unless its series override sets show: false.

Available extensions
Annotations
  • @ChartSurface.new(clearFlags: {'anchorX' : 'clearAnchorX', 'connectorColor' : 'clearConnectorColor', 'backgroundColor' : 'clearBackgroundColor', 'borderColor' : 'clearBorderColor', 'panelBackgroundColor' : 'clearPanelBackgroundColor', 'panelBorderColor' : 'clearPanelBorderColor'})
  • @immutable

Constructors

SeriesCalloutConfig({bool enabled = false, bool showByDefault = true, SeriesCalloutSide side = SeriesCalloutSide.right, SeriesCalloutLanePlacement lanePlacement = SeriesCalloutLanePlacement.plotEdge, SeriesCalloutAnchor anchor = SeriesCalloutAnchor.lastVisible, double? anchorX, SeriesCalloutConnector connector = SeriesCalloutConnector.elbow, SeriesCalloutPacking packing = SeriesCalloutPacking.followAnchors, double laneWidth = 156, double inset = 8, double minimumGap = 6, int maximumVisible = 12, Duration collisionFadeDuration = const Duration(milliseconds: 180), Color? connectorColor, double connectorWidth = 1.25, double connectorOpacity = 1, double connectorGlow = 0, double anchorRadius = 3, EdgeInsets labelPadding = const EdgeInsets.symmetric(horizontal: 8, vertical: 5), TextStyle labelStyle = const TextStyle(fontSize: 12, fontWeight: FontWeight.w600), Color? backgroundColor, double backgroundOpacity = 1, Color? borderColor, double borderWidth = 1, double borderRadius = 5, Color? panelBackgroundColor, double panelOpacity = 1, Color? panelBorderColor, double panelBorderWidth = 0, double panelBorderRadius = 6, EdgeInsets panelPadding = const EdgeInsets.all(6), Map<String, SeriesCalloutSpec> series = const {}})
const

Properties

anchor → SeriesCalloutAnchor
final
anchorRadius → double
final
anchorX → double?
final
backgroundColor → Color?
final
backgroundOpacity → double
final
borderColor → Color?
final
borderRadius → double
final
borderWidth → double
final
collisionFadeDuration → Duration
Time used to fade labels when collision acceptance changes.
final
connector → SeriesCalloutConnector
final
connectorColor → Color?
Fixed connector color. Null inherits each series color.
final
connectorGlow → double
final
connectorOpacity → double
final
connectorWidth → double
final
enabled → bool
final
hashCode → int
The hash code for this object.
no setteroverride
inset → double
final
labelPadding → EdgeInsets
final
labelStyle → TextStyle
final
lanePlacement → SeriesCalloutLanePlacement
final
laneWidth → double
final
maximumVisible → int
final
minimumGap → double
final
packing → SeriesCalloutPacking
final
panelBackgroundColor → Color?
final
panelBorderColor → Color?
final
panelBorderRadius → double
final
panelBorderWidth → double
final
panelOpacity → double
final
panelPadding → EdgeInsets
Space between the content-sized lane panel and its resolved labels.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
series → Map<String, SeriesCalloutSpec>
Overrides keyed by stable ChartSeries.id.
final
showByDefault → bool
final
side → SeriesCalloutSide
final

Methods

clearAnchorX() → SeriesCalloutConfig

Available on SeriesCalloutConfig, provided by the SeriesCalloutConfigFluent extension

Clears SeriesCalloutConfig.anchorX to null.
clearBackgroundColor() → SeriesCalloutConfig

Available on SeriesCalloutConfig, provided by the SeriesCalloutConfigFluent extension

Clears SeriesCalloutConfig.backgroundColor to null.
clearBorderColor() → SeriesCalloutConfig

Available on SeriesCalloutConfig, provided by the SeriesCalloutConfigFluent extension

Clears SeriesCalloutConfig.borderColor to null.
clearConnectorColor() → SeriesCalloutConfig

Available on SeriesCalloutConfig, provided by the SeriesCalloutConfigFluent extension

Clears SeriesCalloutConfig.connectorColor to null.
clearPanelBackgroundColor() → SeriesCalloutConfig

Available on SeriesCalloutConfig, provided by the SeriesCalloutConfigFluent extension

Clears SeriesCalloutConfig.panelBackgroundColor to null.
clearPanelBorderColor() → SeriesCalloutConfig

Available on SeriesCalloutConfig, provided by the SeriesCalloutConfigFluent extension

Clears SeriesCalloutConfig.panelBorderColor to null.
copyWith({bool? enabled, bool? showByDefault, SeriesCalloutSide? side, SeriesCalloutLanePlacement? lanePlacement, SeriesCalloutAnchor? anchor, double? anchorX, SeriesCalloutConnector? connector, SeriesCalloutPacking? packing, double? laneWidth, double? inset, double? minimumGap, int? maximumVisible, Duration? collisionFadeDuration, Color? connectorColor, double? connectorWidth, double? connectorOpacity, double? connectorGlow, double? anchorRadius, EdgeInsets? labelPadding, TextStyle? labelStyle, Color? backgroundColor, double? backgroundOpacity, Color? borderColor, double? borderWidth, double? borderRadius, Color? panelBackgroundColor, double? panelOpacity, Color? panelBorderColor, double? panelBorderWidth, double? panelBorderRadius, EdgeInsets? panelPadding, Map<String, SeriesCalloutSpec>? series, bool clearAnchorX = false, bool clearConnectorColor = false, bool clearBackgroundColor = false, bool clearBorderColor = false, bool clearPanelBackgroundColor = false, bool clearPanelBorderColor = false}) → SeriesCalloutConfig
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
showsSeries(String seriesId) → bool
specFor(String seriesId) → SeriesCalloutSpec
toString() → String
A string representation of this object.
inherited
withAnchor(SeriesCalloutAnchor value) → SeriesCalloutConfig

Available on SeriesCalloutConfig, provided by the SeriesCalloutConfigFluent extension

Replaces SeriesCalloutConfig.anchor with value.
withAnchorRadius(double value) → SeriesCalloutConfig

Available on SeriesCalloutConfig, provided by the SeriesCalloutConfigFluent extension

Replaces SeriesCalloutConfig.anchorRadius with value.
withAnchorX(double value) → SeriesCalloutConfig

Available on SeriesCalloutConfig, provided by the SeriesCalloutConfigFluent extension

Replaces SeriesCalloutConfig.anchorX with value.
withBackgroundColor(Color value) → SeriesCalloutConfig

Available on SeriesCalloutConfig, provided by the SeriesCalloutConfigFluent extension

Replaces SeriesCalloutConfig.backgroundColor with value.
withBackgroundOpacity(double value) → SeriesCalloutConfig

Available on SeriesCalloutConfig, provided by the SeriesCalloutConfigFluent extension

Replaces SeriesCalloutConfig.backgroundOpacity with value.
withBorderColor(Color value) → SeriesCalloutConfig

Available on SeriesCalloutConfig, provided by the SeriesCalloutConfigFluent extension

Replaces SeriesCalloutConfig.borderColor with value.
withBorderRadius(double value) → SeriesCalloutConfig

Available on SeriesCalloutConfig, provided by the SeriesCalloutConfigFluent extension

Replaces SeriesCalloutConfig.borderRadius with value.
withBorderWidth(double value) → SeriesCalloutConfig

Available on SeriesCalloutConfig, provided by the SeriesCalloutConfigFluent extension

Replaces SeriesCalloutConfig.borderWidth with value.
withCollisionFadeDuration(Duration value) → SeriesCalloutConfig

Available on SeriesCalloutConfig, provided by the SeriesCalloutConfigFluent extension

Replaces SeriesCalloutConfig.collisionFadeDuration with value.
withConnector(SeriesCalloutConnector value) → SeriesCalloutConfig

Available on SeriesCalloutConfig, provided by the SeriesCalloutConfigFluent extension

Replaces SeriesCalloutConfig.connector with value.
withConnectorColor(Color value) → SeriesCalloutConfig

Available on SeriesCalloutConfig, provided by the SeriesCalloutConfigFluent extension

Replaces SeriesCalloutConfig.connectorColor with value.
withConnectorGlow(double value) → SeriesCalloutConfig

Available on SeriesCalloutConfig, provided by the SeriesCalloutConfigFluent extension

Replaces SeriesCalloutConfig.connectorGlow with value.
withConnectorOpacity(double value) → SeriesCalloutConfig

Available on SeriesCalloutConfig, provided by the SeriesCalloutConfigFluent extension

Replaces SeriesCalloutConfig.connectorOpacity with value.
withConnectorWidth(double value) → SeriesCalloutConfig

Available on SeriesCalloutConfig, provided by the SeriesCalloutConfigFluent extension

Replaces SeriesCalloutConfig.connectorWidth with value.
withEnabled(bool value) → SeriesCalloutConfig

Available on SeriesCalloutConfig, provided by the SeriesCalloutConfigFluent extension

Replaces SeriesCalloutConfig.enabled with value.
withInset(double value) → SeriesCalloutConfig

Available on SeriesCalloutConfig, provided by the SeriesCalloutConfigFluent extension

Replaces SeriesCalloutConfig.inset with value.
withLabelPadding(EdgeInsets value) → SeriesCalloutConfig

Available on SeriesCalloutConfig, provided by the SeriesCalloutConfigFluent extension

Replaces SeriesCalloutConfig.labelPadding with value.
withLabelStyle(TextStyle value) → SeriesCalloutConfig

Available on SeriesCalloutConfig, provided by the SeriesCalloutConfigFluent extension

Replaces SeriesCalloutConfig.labelStyle with value.
withLanePlacement(SeriesCalloutLanePlacement value) → SeriesCalloutConfig

Available on SeriesCalloutConfig, provided by the SeriesCalloutConfigFluent extension

Replaces SeriesCalloutConfig.lanePlacement with value.
withLaneWidth(double value) → SeriesCalloutConfig

Available on SeriesCalloutConfig, provided by the SeriesCalloutConfigFluent extension

Replaces SeriesCalloutConfig.laneWidth with value.
withMaximumVisible(int value) → SeriesCalloutConfig

Available on SeriesCalloutConfig, provided by the SeriesCalloutConfigFluent extension

Replaces SeriesCalloutConfig.maximumVisible with value.
withMinimumGap(double value) → SeriesCalloutConfig

Available on SeriesCalloutConfig, provided by the SeriesCalloutConfigFluent extension

Replaces SeriesCalloutConfig.minimumGap with value.
withPacking(SeriesCalloutPacking value) → SeriesCalloutConfig

Available on SeriesCalloutConfig, provided by the SeriesCalloutConfigFluent extension

Replaces SeriesCalloutConfig.packing with value.
withPanelBackgroundColor(Color value) → SeriesCalloutConfig

Available on SeriesCalloutConfig, provided by the SeriesCalloutConfigFluent extension

Replaces SeriesCalloutConfig.panelBackgroundColor with value.
withPanelBorderColor(Color value) → SeriesCalloutConfig

Available on SeriesCalloutConfig, provided by the SeriesCalloutConfigFluent extension

Replaces SeriesCalloutConfig.panelBorderColor with value.
withPanelBorderRadius(double value) → SeriesCalloutConfig

Available on SeriesCalloutConfig, provided by the SeriesCalloutConfigFluent extension

Replaces SeriesCalloutConfig.panelBorderRadius with value.
withPanelBorderWidth(double value) → SeriesCalloutConfig

Available on SeriesCalloutConfig, provided by the SeriesCalloutConfigFluent extension

Replaces SeriesCalloutConfig.panelBorderWidth with value.
withPanelOpacity(double value) → SeriesCalloutConfig

Available on SeriesCalloutConfig, provided by the SeriesCalloutConfigFluent extension

Replaces SeriesCalloutConfig.panelOpacity with value.
withPanelPadding(EdgeInsets value) → SeriesCalloutConfig

Available on SeriesCalloutConfig, provided by the SeriesCalloutConfigFluent extension

Replaces SeriesCalloutConfig.panelPadding with value.
withSeries(Map<String, SeriesCalloutSpec> value) → SeriesCalloutConfig

Available on SeriesCalloutConfig, provided by the SeriesCalloutConfigFluent extension

Replaces SeriesCalloutConfig.series with value.
withShowByDefault(bool value) → SeriesCalloutConfig

Available on SeriesCalloutConfig, provided by the SeriesCalloutConfigFluent extension

Replaces SeriesCalloutConfig.showByDefault with value.
withSide(SeriesCalloutSide value) → SeriesCalloutConfig

Available on SeriesCalloutConfig, provided by the SeriesCalloutConfigFluent extension

Replaces SeriesCalloutConfig.side with value.

Operators

operator ==(Object other) → bool
The equality operator.
override