# updateWord

Word-cloud-only — patch a word's datum fields.

Canonical: https://chart.syidax.com/docs/methods/updateWord/

<a id="definition"></a>

## Definition

```typescript
updateWord(idOrIndex: string | number, patch: Partial<Exclude<WordCloudDatum, readonly [string, number]>>): Promise<boolean>
```

| Arguments | Type | Required |
| --- | --- | --- |
| `idOrIndex` | `string \| number` | Required |
| `patch` | `Partial<Exclude<WordCloudDatum, readonly [string, number]>>` | Required |

Return type: `Promise<boolean>`. Call the method after element registration and await its Promise result.

- [WordCloudDatum](https://chart.syidax.com/docs/types/WordCloudDatum.md) — Type definition

<a id="related"></a>

## Related charts

- [sy-word-cloud](https://chart.syidax.com/docs/components/word-cloud.md#method-updateWord)