ScatterBinConfig class

Screen-space layout and presentation for rectangular and hexagonal bins.

Each occupied bin represents one or more raw observations. The source series remains unchanged, and every bin retains the represented source indices for tooltips, selection, table projection, and callbacks.

Available extensions
Annotations
  • @ChartSurface.new(combinedSetters: [CombinedSetter('withOpacityBounds', ['minimumOpacity', 'maximumOpacity'])])

Constructors

ScatterBinConfig({double cellSize = 36, double gap = 1, int minimumPointCount = 1, double minimumOpacity = 0.2, double maximumOpacity = 0.95, ScatterBinAggregate aggregate = ScatterBinAggregate.count, ScatterBinValueSource valueSource = ScatterBinValueSource.y, bool showLabels = false, int labelMinimumPointCount = 10})
const

Properties

aggregate → ScatterBinAggregate
Statistic mapped to bin opacity and optional labels.
final
cellSize → double
Rectangular cell width or flat-top hexagon diameter in logical pixels.
final
gap → double
Visual separation between adjacent bins in logical pixels.
final
hashCode → int
The hash code for this object.
no setteroverride
labelMinimumPointCount → int
Smallest bin count that receives an on-bin label.
final
maximumOpacity → double
Fill opacity assigned to the most populated visible bin.
final
minimumOpacity → double
Fill opacity assigned to the least populated visible bin.
final
minimumPointCount → int
Observations required before an occupied cell is rendered.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
showLabels → bool
Whether qualifying bins display their aggregate value.
final
valueSource → ScatterBinValueSource
Numeric source field used by sum, mean, minimum, and maximum.
final

Methods

copyWith({double? cellSize, double? gap, int? minimumPointCount, double? minimumOpacity, double? maximumOpacity, ScatterBinAggregate? aggregate, ScatterBinValueSource? valueSource, bool? showLabels, int? labelMinimumPointCount}) → ScatterBinConfig
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
override
withAggregate(ScatterBinAggregate value) → ScatterBinConfig

Available on ScatterBinConfig, provided by the ScatterBinConfigFluent extension

Replaces ScatterBinConfig.aggregate with value.
withCellSize(double value) → ScatterBinConfig

Available on ScatterBinConfig, provided by the ScatterBinConfigFluent extension

Replaces ScatterBinConfig.cellSize with value.
withGap(double value) → ScatterBinConfig

Available on ScatterBinConfig, provided by the ScatterBinConfigFluent extension

Replaces ScatterBinConfig.gap with value.
withLabelMinimumPointCount(int value) → ScatterBinConfig

Available on ScatterBinConfig, provided by the ScatterBinConfigFluent extension

Replaces ScatterBinConfig.labelMinimumPointCount with value.
withMinimumPointCount(int value) → ScatterBinConfig

Available on ScatterBinConfig, provided by the ScatterBinConfigFluent extension

Replaces ScatterBinConfig.minimumPointCount with value.
withOpacityBounds(double minimumOpacity, double maximumOpacity) → ScatterBinConfig

Available on ScatterBinConfig, provided by the ScatterBinConfigFluent extension

Replaces ScatterBinConfig.minimumOpacity and ScatterBinConfig.maximumOpacity together.
withShowLabels(bool value) → ScatterBinConfig

Available on ScatterBinConfig, provided by the ScatterBinConfigFluent extension

Replaces ScatterBinConfig.showLabels with value.
withValueSource(ScatterBinValueSource value) → ScatterBinConfig

Available on ScatterBinConfig, provided by the ScatterBinConfigFluent extension

Replaces ScatterBinConfig.valueSource with value.

Operators

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