<!--
{
  "availability" : [
    "iOS: 13.0.0 -",
    "iPadOS: 13.0.0 -",
    "macCatalyst: 13.1.0 -",
    "tvOS: 13.0.0 -",
    "visionOS: 1.0.0 -",
    "watchOS: 6.0.0 -"
  ],
  "documentType" : "symbol",
  "framework" : "UIKit",
  "identifier" : "/documentation/UIKit/UIImage/SymbolConfiguration-swift.class",
  "metadataVersion" : "0.1.0",
  "role" : "Class",
  "symbol" : {
    "kind" : "Class",
    "modules" : [
      "UIKit"
    ],
    "preciseIdentifier" : "c:objc(cs)UIImageSymbolConfiguration"
  },
  "title" : "UIImage.SymbolConfiguration"
}
-->

# UIImage.SymbolConfiguration

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

```
class SymbolConfiguration
```

## 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.

[`UIImage.SymbolConfiguration`](/documentation/UIKit/UIImage/SymbolConfiguration-swift.class) objects are immutable after you create them. If you use the [`applying(_:)`](/documentation/UIKit/UIImage/Configuration-swift.class/applying(_:)) 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`](/documentation/UIKit/UIImageView/preferredSymbolConfiguration) property of the [`UIImageView`](/documentation/UIKit/UIImageView) object you use to display the image. If you draw the image directly, use the [`withConfiguration(_:)`](/documentation/UIKit/UIImage/withConfiguration(_:)) method to create a new image that contains the new attributes.

## Topics

### Creating a symbol configuration

[`init(pointSize:)`](/documentation/UIKit/UIImage/SymbolConfiguration-swift.class/init(pointSize:))

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

[`init(pointSize:weight:)`](/documentation/UIKit/UIImage/SymbolConfiguration-swift.class/init(pointSize:weight:))

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

[`init(pointSize:weight:scale:)`](/documentation/UIKit/UIImage/SymbolConfiguration-swift.class/init(pointSize:weight:scale:))

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

[`init(scale:)`](/documentation/UIKit/UIImage/SymbolConfiguration-swift.class/init(scale:))

Creates a configuration object with the specified scale information.

[`init(textStyle:)`](/documentation/UIKit/UIImage/SymbolConfiguration-swift.class/init(textStyle:))

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

[`init(textStyle:scale:)`](/documentation/UIKit/UIImage/SymbolConfiguration-swift.class/init(textStyle:scale:))

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

[`init(weight:)`](/documentation/UIKit/UIImage/SymbolConfiguration-swift.class/init(weight:))

Creates a configuration object with the specified weight information.

[`init(font:)`](/documentation/UIKit/UIImage/SymbolConfiguration-swift.class/init(font:))

Creates a configuration object with the specified font information.

[`init(font:scale:)`](/documentation/UIKit/UIImage/SymbolConfiguration-swift.class/init(font:scale:))

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

[`UIImage.SymbolScale`](/documentation/UIKit/UIImage/SymbolScale)

Constants that indicate which scale variant of a symbol image to use.

[`UIImage.SymbolWeight`](/documentation/UIKit/UIImage/SymbolWeight)

Constants that indicate which weight variant of a symbol image to use.

[`UIImage.SymbolColorRenderingMode`](/documentation/UIKit/UIImage/SymbolColorRenderingMode)

[`UIImage.SymbolVariableValueMode`](/documentation/UIKit/UIImage/SymbolVariableValueMode)

### Creating a color configuration

[`init(hierarchicalColor:)`](/documentation/UIKit/UIImage/SymbolConfiguration-swift.class/init(hierarchicalColor:))

Creates a color configuration with a color scheme that originates from one color.

[`init(paletteColors:)`](/documentation/UIKit/UIImage/SymbolConfiguration-swift.class/init(paletteColors:))

Creates a color configuration with a color scheme from a palette of multiple colors.

[`preferringMulticolor()`](/documentation/UIKit/UIImage/SymbolConfiguration-swift.class/preferringMulticolor())

Creates a color configuration that specifies that the symbol image uses its multicolor variant, if one exists.

[`preferringMonochrome()`](/documentation/UIKit/UIImage/SymbolConfiguration-swift.class/preferringMonochrome())

Creates a color configuration that specifies that the symbol image uses its monochrome variant.

### Getting an unspecified configuration

[`unspecified`](/documentation/UIKit/UIImage/SymbolConfiguration-swift.class/unspecified)

A symbol configuration object that contains unspecified values for all attributes.

### Removing configuration attributes

[`configurationWithoutPointSizeAndWeight()`](/documentation/UIKit/UIImage/SymbolConfiguration-swift.class/configurationWithoutPointSizeAndWeight())

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

[`configurationWithoutScale()`](/documentation/UIKit/UIImage/SymbolConfiguration-swift.class/configurationWithoutScale())

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

[`configurationWithoutTextStyle()`](/documentation/UIKit/UIImage/SymbolConfiguration-swift.class/configurationWithoutTextStyle())

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

[`configurationWithoutWeight()`](/documentation/UIKit/UIImage/SymbolConfiguration-swift.class/configurationWithoutWeight())

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

### Comparing symbol image configurations

[`isEqual(to:)`](/documentation/UIKit/UIImage/SymbolConfiguration-swift.class/isEqual(to:))

Returns a Boolean value that indicates whether the configuration objects are equivalent.



---

Copyright &copy; 2026 Apple Inc. All rights reserved. | [Terms of Use](https://www.apple.com/legal/internet-services/terms/site.html) | [Privacy Policy](https://www.apple.com/privacy/privacy-policy)