<!-- Source: https://dicebear.zhcndoc.com/guides/access-all-available-options/ -->
<!-- Documentation for DiceBear 10.6.1. The complete docs as one file: https://dicebear.zhcndoc.com/llms-full.txt -->

# 如何以编程方式访问头像样式的所有可用选项？

每种头像样式都会根据其组件和颜色提供不同的选项。
`OptionsDescriptor` 类可让你在运行时发现所有可用选项。

## JavaScript

```js
import { Style, OptionsDescriptor } from '@dicebear/core';
import definition from '@dicebear/styles/micah.json' with { type: 'json' };

const style = new Style(definition);
const descriptor = new OptionsDescriptor(style);

console.log(descriptor.toJSON());
```

## PHP

```php
use Composer\InstalledVersions;
use DiceBear\Style;
use DiceBear\OptionsDescriptor;

$basePath = InstalledVersions::getInstallPath('dicebear/styles');
$style = Style::fromJson(file_get_contents($basePath . '/src/micah.json'));

$descriptor = new OptionsDescriptor($style);

print_r($descriptor->toJSON());
```

## Python

```python
from importlib.resources import files

from dicebear import OptionsDescriptor, Style

style = Style.from_json(
    files("dicebear_styles").joinpath("micah.json").read_text("utf-8")
)

descriptor = OptionsDescriptor(style)

print(descriptor.to_json())
```

## Go

```go
import (
	"fmt"

	dicebear "github.com/dicebear/dicebear-go/v10"
	"github.com/dicebear/styles/v10"
)

style, _ := dicebear.NewStyle([]byte(styles.Micah))
descriptor := dicebear.NewOptionsDescriptor(style).ToJSON()

fmt.Println(descriptor)
```

## Dart

```dart
import 'dart:convert';

import 'package:dicebear_core/dicebear_core.dart';
import 'package:dicebear_styles/micah.dart';

final style = Style.parse(micah);
final descriptor = OptionsDescriptor(style);

print(jsonEncode(descriptor.toJson()));
```

## 字段描述符类型

`toJSON()` 方法返回一个从选项名称到字段描述符的映射。每个
描述符都有一个 `type`，以及根据类型不同而附加的属性：

| 类型      | 属性                                  | 示例选项           |
| --------- | ------------------------------------- | ------------------ |
| `string`  | `list?`                               | `seed`、`fontFamily`     |
| `number`  | `min?`、`max?`、`list?`               | `fontWeight`             |
| `boolean` |                                       | `idRandomization`        |
| `enum`    | `values`、`list?`、`weighted?`        | `flip`、`*Variant`       |
| `color`   | `list?`、`contrastTo?`、`notEqualTo?` | `*Color`                 |
| `range`   | `min?`、`max?`                        | `rotate`、`borderRadius` |

- `list` 表示该选项也接受值数组。
- 枚举字段上的 `weighted` 表示该选项还接受一个
  `Record<string, number>` 权重映射，用于 PRNG 选择。
- 颜色字段上的 `contrastTo` 指定渲染器将要与之进行对比的颜色组，因此 UI
  可以标记该组的选择是由对比度驱动的，而不是随机选择的。仅当样式定义在该组上声明了
  `contrastTo` 约束时才会设置。
- 颜色字段上的 `notEqualTo` 列出该组必须与之不同的颜色组。自行选择颜色的 UI
  必须应用相同的规则，因为每组只有一个明确颜色时，渲染器无法进行过滤。仅当样式定义在该组上声明了
  `notEqualTo` 约束时才会设置。

组件别名（在定义中通过 `extends` 声明）不会将它们自己的 `${alias}Variant` / `${alias}Probability` 条目贡献到描述符中。
它们共享其源组件的用户选项。