Class

UIImageSymbolConfiguration

An object containing the specific font, size, style, and weight attributes to apply to a symbol image.

Declaration

@interface UIImageSymbolConfiguration : UIImageConfiguration

Overview

Symbol image configuration objects include details such as the point size, scale, text style, weight, and font to apply to your symbol image. The system uses these details to determine which variant of the image to use and how to scale or style the image.

UIImageSymbolConfiguration objects are immutable after you create them. If you use the configurationByApplyingConfiguration: method on the object, the new image attributes replace any previous attributes you supplied. After creating a symbol configuration object, assign it to the preferredSymbolConfiguration property of the UIImageView object you use to display the image. If you draw the image directly, use the imageWithConfiguration: method to create a new image that contains the new attributes.

Topics

Creating a Symbol Configuration Object

+ configurationWithPointSize:

Creates a configuration object with the specified point-size information.

+ configurationWithPointSize:weight:

Creates a configuration object with the specified point-size and weight information.

+ configurationWithPointSize:weight:scale:

Creates a configuration object with the specified point-size, weight, and scale information.

+ configurationWithScale:

Creates a configuration object with the specified scale information.

+ configurationWithTextStyle:

Creates a configuration object with the specified font text style information.

+ configurationWithTextStyle:scale:

Creates a configuration object with the specified font text style and scale information.

+ configurationWithWeight:

Creates a configuration object with the specified weight information.

+ configurationWithFont:

Creates a new configuration object that with the specified font information.

+ configurationWithFont:scale:

Creates a new configuration object with the specified font and scale information.

UIImageSymbolScale

Constants indicating which scale variant of a symbol image to use.

UIImageSymbolWeight

Constants indicating which weight variant of a symbol image to use.

Getting an Unspecified Configuration

unspecifiedConfiguration

A symbol configuration object containing unspecified values for all attributes.

Removing Configuration Attributes

- configurationWithoutPointSizeAndWeight

Returns a copy of the current symbol configuration object without point-size and weight information.

- configurationWithoutScale

Returns a copy of the current symbol configuration object without scale information.

- configurationWithoutTextStyle

Returns a copy of the current symbol configuration object without text style information.

- configurationWithoutWeight

Returns a copy of the current symbol configuration object without weight information.

Comparing Symbol Image Configurations

- isEqualToConfiguration:

Returns a Boolean value indicating whether the configuration objects are equivalent.

Relationships

See Also

Representations

UIImage

An object that manages image data in your app.

UIImageConfiguration

A configuration object containing the traits that the system used when selecting the current image variant.