Instance Property

symbolConfiguration

The configuration details for a symbol image.

Declaration

@NSCopying var symbolConfiguration: UIImage.SymbolConfiguration? { get }

Discussion

Use this property to access the traits and drawing-related attributes associated with the symbol image. The system uses the specified details to determine which variant of the image to load and draw and how to render it, falling back on the current environment as needed for any unspecified values. For symbol images, the default value of this property is a symbol image configuration object with unspecified values. For other image types, the default value of this property is nil.

You cannot modify this property directly, but you can use the withConfiguration(_:) method to create a new image object with a specific set of traits. You might do so when you want to render the image yourself using a specific set of traits.

If the image is a symbol image, this property always contains a UIImage.SymbolConfiguration object.

See Also

Getting the Image Configuration

var configuration: UIImage.Configuration?

The configuration details for the image.

var traitCollection: UITraitCollection

The trait collection that describes the current variant of the image.