Interface DataHealthPanelParams

Constructor parameters for DataHealthPanel.

interface DataHealthPanelParams {
    container?: HTMLElement;
    data?: Data;
    dataModel?: DataModel;
    focusDataModel?: DataModel;
    inspectParams?: Partial<InspectDataModelParams>;
    schema?: DataFormatSchema;
    storageKey?: string;
    visible?: boolean;
}

Properties

container?: HTMLElement

DOM element to mount into. Defaults to document.body.

data?: Data

The Data to surface. If omitted, derived from focusDataModel's .data.

dataModel?: DataModel

Backwards-compatible alias for focusDataModel.

Prefer focusDataModel.

focusDataModel?: DataModel

DataModel to focus on first open. Optional — when omitted, the first DataModel in the Data is selected.

inspectParams?: Partial<InspectDataModelParams>

Initial inspection params. Each opt-in inspection's flag here lights up the matching toggle in the Inspections subpanel. Defaults to all opt-in checks enabled.

Optional DataFormatSchema the DataModel is expected to conform to. When supplied, schema-aware inspections light up; otherwise only structural always-on inspections fire.

storageKey?: string

localStorage key for persisting drag position + closed state. Defaults to "xkt-dh-panel".

visible?: boolean

Show the panel on construction (default true).