BoxFit enum

How a box should be inscribed into another box.

See also:

  • applyBoxFit, which applies the sizing semantics of these values (though not the alignment semantics).
Inheritance

Values

fill → const BoxFit

Fill the target box by distorting the source's aspect ratio.

contain → const BoxFit

As large as possible while still containing the source entirely within the target box.

cover → const BoxFit

As small as possible while still covering the entire target box.

To actually clip the content, use clipBehavior: Clip.hardEdge alongside this in a FittedBox.

fitWidth → const BoxFit

Make sure the full width of the source is shown, regardless of whether this means the source overflows the target box vertically.

To actually clip the content, use clipBehavior: Clip.hardEdge alongside this in a FittedBox.

fitHeight → const BoxFit

Make sure the full height of the source is shown, regardless of whether this means the source overflows the target box horizontally.

To actually clip the content, use clipBehavior: Clip.hardEdge alongside this in a FittedBox.

none → const BoxFit

Align the source within the target box (by default, centering) and discard any portions of the source that lie outside the box.

The source image is not resized.

To actually clip the content, use clipBehavior: Clip.hardEdge alongside this in a FittedBox.

scaleDown → const BoxFit

Align the source within the target box (by default, centering) and, if necessary, scale the source down to ensure that the source fits within the box.

This is the same as contain if that would shrink the image, otherwise it is the same as none.

Properties

hashCode → int
The hash code for this object.
no setterinherited
index → int
A numeric identifier for the enumerated value.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

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

Constants

values → const List<BoxFit>
A constant List of the values in this enum, in order of their declaration.