Enumeration

UIImageSymbolScale

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

Declaration

typedef enum UIImageSymbolScale : NSInteger {
    ...
} UIImageSymbolScale;

Overview

The definition of a symbol image includes multiple scale and weight variants. Scale variants offer a way to define the size of the image relative to layout guides in the symbol image's definition file. The system chooses the appropriate size variant based on the available space and configuration options.

Topics

Symbol Image Scales

UIImageSymbolScaleDefault

The default scale variant that matches the system usage.

UIImageSymbolScaleUnspecified

An unspecified scale.

UIImageSymbolScaleSmall

The small variant of the symbol image.

UIImageSymbolScaleMedium

The medium variant of the symbol image

UIImageSymbolScaleLarge

The large variant of the symbol image.

See Also

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.

UIImageSymbolWeight

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