CachedNetworkImage class
Image widget to show NetworkImage with caching functionality.
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatelessWidget
- CachedNetworkImage
Constructors
-
CachedNetworkImage({Key? key, required String imageUrl, Map<
String, String> ? httpHeaders, ImageWidgetBuilder? imageBuilder, PlaceholderWidgetBuilder? placeholder, ProgressIndicatorBuilder? progressIndicatorBuilder, LoadingErrorWidgetBuilder? errorWidget, Duration? fadeOutDuration = const Duration(milliseconds: 1000), Curve fadeOutCurve = Curves.easeOut, Duration fadeInDuration = const Duration(milliseconds: 500), Curve fadeInCurve = Curves.easeIn, double? width, double? height, BoxFit? fit, Alignment alignment = Alignment.center, ImageRepeat repeat = ImageRepeat.noRepeat, bool matchTextDirection = false, BaseCacheManager? cacheManager, bool useOldImageOnUrlChange = false, Color? color, FilterQuality filterQuality = FilterQuality.low, BlendMode? colorBlendMode, Duration? placeholderFadeInDuration, int? memCacheWidth, int? memCacheHeight, String? cacheKey, int? maxWidthDiskCache, int? maxHeightDiskCache, ValueChanged<Object> ? errorListener, ImageRenderMethodForWeb imageRenderMethodForWeb = ImageRenderMethodForWeb.HtmlImage, double scale = 1.0}) - CachedNetworkImage shows a network image using a caching mechanism. It also provides support for a placeholder, showing an error and fading into the loaded image. Next to that it supports most features of a default Image widget.
Properties
- alignment → Alignment
-
How to align the image within its bounds.
final
- cacheKey → String?
-
The target image's cache key.
final
- cacheManager → BaseCacheManager?
-
Option to use cacheManager with other settings
final
- color → Color?
-
If non-null, this color is blended with each image pixel using colorBlendMode.
final
- colorBlendMode → BlendMode?
-
Used to combine color with this image.
final
-
errorListener
→ ValueChanged<
Object> ? -
Listener to be called when images fails to load.
final
- errorWidget → LoadingErrorWidgetBuilder?
-
Widget displayed while the target imageUrl failed loading.
final
- fadeInCurve → Curve
-
The curve of the fade-in animation for the imageUrl.
final
- fadeInDuration → Duration
-
The duration of the fade-in animation for the imageUrl.
final
- fadeOutCurve → Curve
-
The curve of the fade-out animation for the placeholder.
final
- fadeOutDuration → Duration?
-
The duration of the fade-out animation for the placeholder.
final
- filterQuality → FilterQuality
-
Target the interpolation quality for image scaling.
final
- fit → BoxFit?
-
How to inscribe the image into the space allocated during layout.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- height → double?
-
If non-null, require the image to have this height.
final
-
httpHeaders
→ Map<
String, String> ? -
Optional headers for the http request of the image url
final
- imageBuilder → ImageWidgetBuilder?
-
Optional builder to further customize the display of the image.
final
- imageUrl → String
-
The target image that is displayed.
final
- key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
- matchTextDirection → bool
-
Whether to paint the image in the direction of the TextDirection.
final
- maxHeightDiskCache → int?
-
Will resize the image and store the resized image in the disk cache.
final
- maxWidthDiskCache → int?
-
Will resize the image and store the resized image in the disk cache.
final
- memCacheHeight → int?
-
Will resize the image in memory to have a certain height using ResizeImage
final
- memCacheWidth → int?
-
Will resize the image in memory to have a certain width using ResizeImage
final
- placeholder → PlaceholderWidgetBuilder?
-
Widget displayed while the target imageUrl is loading.
final
- placeholderFadeInDuration → Duration?
-
The duration of the fade-in animation for the placeholder.
final
- progressIndicatorBuilder → ProgressIndicatorBuilder?
-
Widget displayed while the target imageUrl is loading.
final
- repeat → ImageRepeat
-
How to paint any portions of the layout bounds not covered by the image.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- useOldImageOnUrlChange → bool
-
When set to true it will animate from the old image to the new image
if the url changes.
final
- width → double?
-
If non-null, require the image to have this width.
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.
inherited
-
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, int wrapWidth = 65}) → 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
Static Properties
- logLevel ↔ CacheManagerLogLevel
-
Get the current log level of the cache manager.
getter/setter pair
Static Methods
-
evictFromCache(
String url, {String? cacheKey, BaseCacheManager? cacheManager, double scale = 1}) → Future< bool> -
Evict an image from both the disk file based caching system of the
BaseCacheManager
as the in memory ImageCache of the ImageProvider.url
is used by both the disk and memory cache. The scale is only used to clear the image from the ImageCache.