CapacityIndicator class
A capacity indicator illustrates the current level in relation to a finite capacity. Capacity indicators are often used when communicating factors like disk and battery usage. Mail, for example, uses a capacity indicator to show the percentage of data used in relation to an email account’s quota.
There are two types of capacity indicators:
- Continuous
A horizontal translucent track that fills with a colored bar to indicate the current value. Tick marks are often displayed to provide context.
- Discrete
A horizontal row of separate, equally sized, rectangular segments. The number of segments matches the total capacity, and the segments fill completely—never partially—with color to indicate the current value.
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatelessWidget
- CapacityIndicator
Constructors
-
CapacityIndicator({Key? key, required double value, ValueChanged<
double> ? onChanged, bool discrete = false, int splits = 10, Color color = CupertinoColors.systemGreen, Color borderColor = CupertinoColors.tertiaryLabel, Color backgroundColor = CupertinoColors.tertiarySystemGroupedBackground, String? semanticLabel}) -
Creates a capacity indicator.
const
Properties
- backgroundColor → Color
-
The background color of the cells. CupertinoColors.tertiarySystemGroupedBackground
is used by default
final
- borderColor → Color
-
The border color of the cells. CupertinoColors.tertiaryLabel
is used by default
final
- color → Color
-
The color to fill the cells. CupertinoColors.systemGreen is
used by default.
final
- discrete → bool
-
Whether the indicator is discrete or not
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
-
onChanged
→ ValueChanged<
double> ? -
Called when the current value of the indicator changes.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- semanticLabel → String?
-
The semantic label used by screen readers.
final
- splits → int
-
How many parts the indicator will be splitted in if discrete
is true. Defaults to 10.
final
- value → double
-
The current value of the indicator. Must be in the range of 0 to 100.
final
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.
override
-
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}) → 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