API REFERENCE

updateWord

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

Definition

typescript
updateWord(idOrIndex: string | number, patch: Partial<Exclude<WordCloudDatum, readonly [string, number]>>): Promise<boolean>
ArgumentsTypeRequired
idOrIndexstring | numberRequired
patchPartial<Exclude<WordCloudDatum, readonly [string, number]>>Required

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