# UserStyleSetting.LargeCustomValueUserStyleSetting

# UserStyleSetting.LargeCustomValueUserStyleSetting

Artifact:[androidx.wear.watchface:watchface-style](https://developer.android.com/jetpack/androidx/releases/wear-watchface)  
[View Source](https://cs.android.com/search?q=file:androidx/wear/watchface/style/UserStyleSetting.kt+class:androidx.wear.watchface.style.UserStyleSetting.LargeCustomValueUserStyleSetting)  
Added in[1.2.0](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.2.0)  
Deprecated in[1.3.0-alpha07](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.3.0-alpha07)

*** ** * ** ***

Kotlin\|[Java](https://developer.android.com/reference/androidx/wear/watchface/style/UserStyleSetting.LargeCustomValueUserStyleSetting "View this page in Java")

<br />

```
@RequiresApi(value = 33)
class UserStyleSetting.LargeCustomValueUserStyleSetting : UserStyleSetting
```

<br />

|---|---|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [kotlin.Any](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html)                                                                                                                                      |||
| ↳ | [androidx.wear.watchface.style.UserStyleSetting](https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/UserStyleSetting)                                                                      ||
|   | ↳ | [androidx.wear.watchface.style.UserStyleSetting.LargeCustomValueUserStyleSetting](https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/UserStyleSetting.LargeCustomValueUserStyleSetting) |

*** ** * ** ***

| **This class is deprecated.**   
| AndroidX watchface libraries are deprecated, use Watch Face Format instead. For more info see: https://developer.android.com/training/wearables/wff

An application specific style setting which supports a larger maximum size than[CustomValueUserStyleSetting](https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/UserStyleSetting.CustomValueUserStyleSetting). This style is ignored by the system editor. This is expected to be used in conjunction with an on watch face editor. Only a single[ComplicationSlotsUserStyleSetting](https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/UserStyleSetting.ComplicationSlotsUserStyleSetting)or[LargeCustomValueUserStyleSetting](https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/UserStyleSetting.LargeCustomValueUserStyleSetting)is permitted in the[UserStyleSchema](https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/UserStyleSchema).

The[CustomValueOption](https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/UserStyleSetting.LargeCustomValueUserStyleSetting.CustomValueOption)can store at most[Option.Id.MAX_LENGTH](https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/UserStyleSetting.Option.Id#MAX_LENGTH())bytes.

## Summary

|                                                                                                                                                                                                                               ### Nested types                                                                                                                                                                                                                               |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `class `[UserStyleSetting.LargeCustomValueUserStyleSetting.CustomValueOption](https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/UserStyleSetting.LargeCustomValueUserStyleSetting.CustomValueOption)` : `[UserStyleSetting.Option](https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/UserStyleSetting.Option) **This class is deprecated.**AndroidX watchface libraries are deprecated, use Watch Face Format instead. |

|                                                                                                                                                                                                                                                                                                                                                          ### Public constructors                                                                                                                                                                                                                                                                                                                                                          |
|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| ~~[LargeCustomValueUserStyleSetting](https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/UserStyleSetting.LargeCustomValueUserStyleSetting#LargeCustomValueUserStyleSetting(kotlin.collections.Collection,kotlin.ByteArray))~~`(` ` affectsWatchFaceLayers: `[Collection](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-collection/index.html)`<`[WatchFaceLayer](https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/WatchFaceLayer)`>,` ` defaultValue: `[ByteArray](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-byte-array/index.html) `)` **This function is deprecated.**AndroidX watchface libraries are deprecated, use Watch Face Format instead. |

|                                                          ### Public functions                                                          |
|----------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `open `[UserStyleSetting.Option](https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/UserStyleSetting.Option) | ~~[getOptionForId](https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/UserStyleSetting.LargeCustomValueUserStyleSetting#getOptionForId(androidx.wear.watchface.style.UserStyleSetting.Option.Id))~~`(optionId: `[UserStyleSetting.Option.Id](https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/UserStyleSetting.Option.Id)`)` **This function is deprecated.**AndroidX watchface libraries are deprecated, use Watch Face Format instead. |

|                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           ### Inherited functions                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| From[androidx.wear.watchface.style.UserStyleSetting](https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/UserStyleSetting) |-----------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `open operator `[Boolean](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html) | ~~[equals](https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/UserStyleSetting#equals(kotlin.Any))~~`(other: `[Any](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html)`?)` **This function is deprecated.**AndroidX watchface libraries are deprecated, use Watch Face Format instead. | | `open `[Int](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html)                  | ~~[hashCode](https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/UserStyleSetting#hashCode())~~`()` **This function is deprecated.**AndroidX watchface libraries are deprecated, use Watch Face Format instead.                                                                                            | | `open `[String](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html)            | ~~[toString](https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/UserStyleSetting#toString())~~`()` **This function is deprecated.**AndroidX watchface libraries are deprecated, use Watch Face Format instead.                                                                                            | |

|                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ### Inherited properties                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| From[androidx.wear.watchface.style.UserStyleSetting](https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/UserStyleSetting) |--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [Collection](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-collection/index.html)`<`[WatchFaceLayer](https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/WatchFaceLayer)`>`       | [affectedWatchFaceLayers](https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/UserStyleSetting#affectedWatchFaceLayers()) **This property is deprecated.**AndroidX watchface libraries are deprecated, use Watch Face Format instead. | | [UserStyleSetting.Option](https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/UserStyleSetting.Option)                                                                                                | [defaultOption](https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/UserStyleSetting#defaultOption()) **This property is deprecated.**AndroidX watchface libraries are deprecated, use Watch Face Format instead.                     | | [Int](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html)                                                                                                                                                    | [defaultOptionIndex](https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/UserStyleSetting#defaultOptionIndex()) **This property is deprecated.**AndroidX watchface libraries are deprecated, use Watch Face Format instead.           | | [CharSequence](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-char-sequence/index.html)                                                                                                                                 | [description](https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/UserStyleSetting#description()) **This property is deprecated.**AndroidX watchface libraries are deprecated, use Watch Face Format instead.                         | | [CharSequence](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-char-sequence/index.html)                                                                                                                                 | [displayName](https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/UserStyleSetting#displayName()) **This property is deprecated.**AndroidX watchface libraries are deprecated, use Watch Face Format instead.                         | | [Icon](https://developer.android.com/reference/android/graphics/drawable/Icon.html)`?`                                                                                                                                         | [icon](https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/UserStyleSetting#icon()) **This property is deprecated.**AndroidX watchface libraries are deprecated, use Watch Face Format instead.                                       | | [UserStyleSetting.Id](https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/UserStyleSetting.Id)                                                                                                        | [id](https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/UserStyleSetting#id()) **This property is deprecated.**AndroidX watchface libraries are deprecated, use Watch Face Format instead.                                           | | [List](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html)`<`[UserStyleSetting.Option](https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/UserStyleSetting.Option)`>` | [options](https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/UserStyleSetting#options()) **This property is deprecated.**AndroidX watchface libraries are deprecated, use Watch Face Format instead.                                 | | [UserStyleSetting.WatchFaceEditorData](https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/UserStyleSetting.WatchFaceEditorData)`?`                                                                   | [watchFaceEditorData](https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/UserStyleSetting#watchFaceEditorData()) **This property is deprecated.**AndroidX watchface libraries are deprecated, use Watch Face Format instead.         | |

## Public constructors

### LargeCustomValueUserStyleSetting

```
[LargeCustomValueUserStyleSetting](https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/UserStyleSetting.LargeCustomValueUserStyleSetting#LargeCustomValueUserStyleSetting(kotlin.collections.Collection,kotlin.ByteArray))(
    affectsWatchFaceLayers: Collection<WatchFaceLayer>,
    defaultValue: ByteArray
)
```
| **This function is deprecated.**   
| AndroidX watchface libraries are deprecated, use Watch Face Format instead. For more info see: https://developer.android.com/training/wearables/wff

Constructs a LargeCustomValueUserStyleSetting.  

|                                                                                                                     Parameters                                                                                                                     |
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------|
| `affectsWatchFaceLayers: `[Collection](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-collection/index.html)`<`[WatchFaceLayer](https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/WatchFaceLayer)`>` | Used by the style configuration UI. Describes which watch face rendering layers this style affects.        |
| `defaultValue: `[ByteArray](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-byte-array/index.html)                                                                                                                                           | The default value[ByteArray](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-byte-array/index.html). |

## Public functions

### getOptionForId

```
open fun [getOptionForId](https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/UserStyleSetting.LargeCustomValueUserStyleSetting#getOptionForId(androidx.wear.watchface.style.UserStyleSetting.Option.Id))(optionId: UserStyleSetting.Option.Id): UserStyleSetting.Option
```
| **This function is deprecated.**   
| AndroidX watchface libraries are deprecated, use Watch Face Format instead. For more info see: https://developer.android.com/training/wearables/wff

Translates an option name into an option. This will need to be overridden for userStyle categories that can't sensibly be fully enumerated (e.g. a full 24-bit color picker).  

|                                                                    Parameters                                                                     |
|---------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------|
| `optionId: `[UserStyleSetting.Option.Id](https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/UserStyleSetting.Option.Id) | The[Option.Id](https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/UserStyleSetting.Option.Id)of the option |

|                                                             Returns                                                             |
|---------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [UserStyleSetting.Option](https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/UserStyleSetting.Option) | An[Option](https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/UserStyleSetting.Option)corresponding to the name. This could either be one of the options from[UserStyleSetting](https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/UserStyleSetting)s or a newly constructed Option depending on the nature of the UserStyleSetting. If optionName is unrecognized then the default value for the setting should be returned. |