SfSymbolConfig class

Everything that identifies one rendered symbol image.

Two configs that compare equal produce the same image, which makes this usable as a cache key.

Annotations

Constructors

SfSymbolConfig({required String name, required double size, FontWeight weight = FontWeight.normal, SfSymbolScale scale = SfSymbolScale.medium, SfSymbolRenderingMode renderingMode = SfSymbolRenderingMode.monochrome, List<Color> colors = const <Color>[], double? variableValue, SfSymbolEffect? effect, bool effectRepeats = true})
const

Properties

colors → List<Color>
The colors the renderingMode draws with.
final
effect → SfSymbolEffect?
The animation to run, or null for a still symbol.
final
effectRepeats → bool
Whether effect repeats, or plays once when the symbol appears.
final
hashCode → int
The hash code for this object.
no setteroverride
isAnimated → bool
Whether this symbol animates, and so cannot be shared with others.
no setter
name → String
The SF Symbol name, e.g. camera.aperture.
final
renderingMode → SfSymbolRenderingMode
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
scale → SfSymbolScale
final
size → double
Point size of the symbol, in logical pixels.
final
variableValue → double?
Fill level for variable symbols such as wifi or speaker.wave.3, between 0.0 and 1.0. Requires iOS 16 or macOS 13; ignored on earlier versions.
final
weight → FontWeight
final

Methods

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

Operators

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