SvgImage class

SVG images renderer.

Actual renderer is determined based on the current platform:

  • SvgPicture is used on all non-web platforms and on web with CanvasKit renderer;
  • Image.network is used on web with html-renderer.
Inheritance
Available extensions

Constructors

SvgImage.asset(String? asset, {Key? key, Alignment? alignment = Alignment.center, BoxFit? fit = BoxFit.contain, double? width, double? height, WidgetBuilder? placeholderBuilder, String? semanticsLabel, bool? excludeFromSemantics = false})
Instantiates a widget rendering an SVG picture from an AssetBundle.
const
SvgImage.bytes(Uint8List? bytes, {Key? key, Alignment? alignment = Alignment.center, BoxFit? fit = BoxFit.cover, double? width, double? height, WidgetBuilder? placeholderBuilder, String? semanticsLabel, bool? excludeFromSemantics = false})
Instantiates a widget rendering an SVG picture from an Uint8List.
const
SvgImage.file(File? file, {Key? key, Alignment? alignment = Alignment.center, BoxFit? fit = BoxFit.cover, double? width, double? height, WidgetBuilder? placeholderBuilder, String? semanticsLabel, bool? excludeFromSemantics = false})
Instantiates a widget rendering an SVG picture from a File.
const
SvgImage.icon(SvgData data, {Key? key, Alignment? alignment = Alignment.center, BoxFit? fit = BoxFit.contain, double? width, double? height, WidgetBuilder? placeholderBuilder, String? semanticsLabel, bool? excludeFromSemantics = false})
Instantiates a widget rendering an SVG picture from a SvgData.

Properties

alignment Alignment?
Alignment to display this image with.
final
asset String?
Path to an asset containing an SVG image to display.
final
bytes Uint8List?
Uint8List bytes containing an SVG image to display.
final
excludeFromSemantics bool?
Indicator whether this Widget should be excluded from the Semantics.
final
file File?
File representing an SVG image to display.
final
fit BoxFit?
BoxFit to apply to this image.
final
hashCode int
The hash code for this object.
no setterinherited
height double?
Height to constrain this image with.
final
key Key?
Controls how one widget replaces another widget in the tree.
finalinherited
marginZero Widget

Available on Widget, provided by the WidgetMarginX extension

no setter
paddingZero Widget

Available on Widget, provided by the WidgetPaddingX extension

no setter
placeholderBuilder WidgetBuilder?
Builder, building a Widget to display when this SVG image is being loaded, fetched or initialized.
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
semanticsLabel String?
Label to put on the Semantics of this Widget.
final
sliverBox Widget

Available on Widget, provided by the WidgetSliverBoxX extension

no setter
width double?
Width to constrain this image with.
final

Methods

animate({Key? key, List<Effect>? effects, AnimateCallback? onInit, AnimateCallback? onPlay, AnimateCallback? onComplete, bool? autoPlay, Duration? delay, AnimationController? controller, Adapter? adapter, double? target, double? value}) Animate

Available on Widget, provided by the AnimateWidgetExtensions extension

Wraps the target Widget in an Animate instance, and returns the instance for chaining calls. Ex. myWidget.animate() is equivalent to Animate(child: myWidget).
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
marginAll(double margin) Widget

Available on Widget, provided by the WidgetMarginX extension

marginOnly({double left = 0.0, double top = 0.0, double right = 0.0, double bottom = 0.0}) Widget

Available on Widget, provided by the WidgetMarginX extension

marginSymmetric({double horizontal = 0.0, double vertical = 0.0}) Widget

Available on Widget, provided by the WidgetMarginX extension

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
paddingAll(double padding) Widget

Available on Widget, provided by the WidgetPaddingX extension

paddingOnly({double left = 0.0, double top = 0.0, double right = 0.0, double bottom = 0.0}) Widget

Available on Widget, provided by the WidgetPaddingX extension

paddingSymmetric({double horizontal = 0.0, double vertical = 0.0}) Widget

Available on Widget, provided by the WidgetPaddingX extension

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