@sqlrooms/mosaic / isChartPanelConfig

Function: isChartPanelConfig()

isChartPanelConfig(panel): panel is { id: string; type: "vgplot"; title: string; config: { chartType: "histogram"; settings: { field?: string; maxBins?: number; color?: string }; settingsOpen?: boolean; dataPolicy?: { disabled?: boolean; maxRows?: number; reason?: string } } | { chartType: "count-plot"; settings: { field?: string }; settingsOpen?: boolean; dataPolicy?: { disabled?: boolean; maxRows?: number; reason?: string } } | { chartType: "line-chart"; settings: { x?: string; xInterval?: "second" | "minute" | "hour" | "day" | "week" | "month" | "quarter" | "year"; yFields?: { field: string; color?: string; aggregate: "sum" | "max" | "min" | "avg" }[]; showLegend: boolean }; settingsOpen?: boolean; dataPolicy?: { disabled?: boolean; maxRows?: number; reason?: string } } | { chartType: "scatter-plot"; settings: { x?: string; y?: string; size?: string }; settingsOpen?: boolean; dataPolicy?: { disabled?: boolean; maxRows?: number; reason?: string } } | { chartType: "heatmap"; settings: { x?: string; y?: string }; settingsOpen?: boolean; dataPolicy?: { disabled?: boolean; maxRows?: number; reason?: string } } | { chartType: "box-plot"; settings: { x?: string; y?: string }; settingsOpen?: boolean; dataPolicy?: { disabled?: boolean; maxRows?: number; reason?: string } } | { chartType: "custom-spec"; settingsOpen?: boolean; settings: { vgPlotSpec?: unknown }; dataPolicy?: { disabled?: boolean; maxRows?: number; reason?: string } } | { chartType: string; settings: Record<string, unknown>; settingsOpen?: boolean; dataPolicy?: { disabled?: boolean; maxRows?: number; reason?: string } } }

Parameters

Parameter

Type

panel

{ id: string; type: "vgplot"; title: string; config: { chartType: "histogram"; settings: { field?: string; maxBins?: number; color?: string; }; settingsOpen?: boolean; dataPolicy?: { disabled?: boolean; maxRows?: number; reason?: string; }; } | { chartType: "count-plot"; settings: { field?: string; }; settingsOpen?: boolean; dataPolicy?: { disabled?: boolean; maxRows?: number; reason?: string; }; } | { chartType: "line-chart"; settings: { x?: string; xInterval?: "second" | "minute" | "hour" | "day" | "week" | "month" | "quarter" | "year"; yFields?: object[]; showLegend: boolean; }; settingsOpen?: boolean; dataPolicy?: { disabled?: boolean; maxRows?: number; reason?: string; }; } | { chartType: "scatter-plot"; settings: { x?: string; y?: string; size?: string; }; settingsOpen?: boolean; dataPolicy?: { disabled?: boolean; maxRows?: number; reason?: string; }; } | { chartType: "heatmap"; settings: { x?: string; y?: string; }; settingsOpen?: boolean; dataPolicy?: { disabled?: boolean; maxRows?: number; reason?: string; }; } | { chartType: "box-plot"; settings: { x?: string; y?: string; }; settingsOpen?: boolean; dataPolicy?: { disabled?: boolean; maxRows?: number; reason?: string; }; } | { chartType: "custom-spec"; settingsOpen?: boolean; settings: { vgPlotSpec?: unknown; }; dataPolicy?: { disabled?: boolean; maxRows?: number; reason?: string; }; } | { chartType: string; settings: Record<string, unknown>; settingsOpen?: boolean; dataPolicy?: { disabled?: boolean; maxRows?: number; reason?: string; }; }; } | { id: string; type: "data-table-explorer"; title: string; config: { pageSize?: number; }; } | { id: string; type: string; title: string; config: Record<string, unknown>; }

Returns

panel is { id: string; type: "vgplot"; title: string; config: { chartType: "histogram"; settings: { field?: string; maxBins?: number; color?: string }; settingsOpen?: boolean; dataPolicy?: { disabled?: boolean; maxRows?: number; reason?: string } } | { chartType: "count-plot"; settings: { field?: string }; settingsOpen?: boolean; dataPolicy?: { disabled?: boolean; maxRows?: number; reason?: string } } | { chartType: "line-chart"; settings: { x?: string; xInterval?: "second" | "minute" | "hour" | "day" | "week" | "month" | "quarter" | "year"; yFields?: { field: string; color?: string; aggregate: "sum" | "max" | "min" | "avg" }[]; showLegend: boolean }; settingsOpen?: boolean; dataPolicy?: { disabled?: boolean; maxRows?: number; reason?: string } } | { chartType: "scatter-plot"; settings: { x?: string; y?: string; size?: string }; settingsOpen?: boolean; dataPolicy?: { disabled?: boolean; maxRows?: number; reason?: string } } | { chartType: "heatmap"; settings: { x?: string; y?: string }; settingsOpen?: boolean; dataPolicy?: { disabled?: boolean; maxRows?: number; reason?: string } } | { chartType: "box-plot"; settings: { x?: string; y?: string }; settingsOpen?: boolean; dataPolicy?: { disabled?: boolean; maxRows?: number; reason?: string } } | { chartType: "custom-spec"; settingsOpen?: boolean; settings: { vgPlotSpec?: unknown }; dataPolicy?: { disabled?: boolean; maxRows?: number; reason?: string } } | { chartType: string; settings: Record<string, unknown>; settingsOpen?: boolean; dataPolicy?: { disabled?: boolean; maxRows?: number; reason?: string } } }