index | References | ArcGIS Maps SDK for JavaScript

ESM

import { validateWebChart } from "@arcgis/charts-components/utils/chart-config/validator/index.js";

Functions

Name	Return Type	Object
`validateWebChart`	`Promise<ValidationStatus>`

Function

Validates the WebChart config and display either Errors or Warnings.

Errors: Violations in the config with regard to the JSON schema.
Warnings: Undesired combinations in the config which don't violate the JSON schema but should still be blocked.

Signature: validateWebChart (props: { input?: WebChart | WebGaugeChart; queryObject?: QueryObject; allowUsingObjectIdStat?: boolean; }): Promise<ValidationStatus>

Parameter	Type	Description	Required
props	`{ input?: WebChart \| WebGaugeChart; queryObject?: QueryObject; allowUsingObjectIdStat?: boolean; }`	The input config, the query object and whether to allow using the object id field as a statistic field.