@sqlrooms/mosaic / isVgPlotPanelConfig

Function: isVgPlotPanelConfig()

isVgPlotPanelConfig(panel): panel is { id: string; type: "vgplot"; title: string; source?: { tableName?: string; sqlQuery?: string }; config: { chartType: "histogram"; settings: { field?: string }; settingsOpen?: boolean } | { chartType: "count-plot"; settings: { field?: string }; settingsOpen?: boolean } | { 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" }[] }; settingsOpen?: boolean } | { chartType: "bubble-chart"; settings: { x?: string; y?: string; size?: string }; settingsOpen?: boolean } | { chartType: "heatmap"; settings: { x?: string; y?: string }; settingsOpen?: boolean } | { chartType: "box-plot"; settings: { x?: string; y?: string }; settingsOpen?: boolean } | { chartType: "custom-spec"; settingsOpen?: boolean; settings: { vgPlotSpec?: unknown } } }

Parameters

Parameter

Type

panel

{ id: string; type: "vgplot"; title: string; source?: { tableName?: string; sqlQuery?: string; }; config: { chartType: "histogram"; settings: { field?: string; }; settingsOpen?: boolean; } | { chartType: "count-plot"; settings: { field?: string; }; settingsOpen?: boolean; } | { chartType: "line-chart"; settings: { x?: string; xInterval?: "second" | "minute" | "hour" | "day" | "week" | "month" | "quarter" | "year"; yFields?: object[]; }; settingsOpen?: boolean; } | { chartType: "bubble-chart"; settings: { x?: string; y?: string; size?: string; }; settingsOpen?: boolean; } | { chartType: "heatmap"; settings: { x?: string; y?: string; }; settingsOpen?: boolean; } | { chartType: "box-plot"; settings: { x?: string; y?: string; }; settingsOpen?: boolean; } | { chartType: "custom-spec"; settingsOpen?: boolean; settings: { vgPlotSpec?: unknown; }; }; } | { id: string; type: "profiler"; title: string; source?: { tableName?: string; sqlQuery?: string; }; config: { pageSize?: number; }; } | { id: string; type: string; title: string; source?: { tableName?: string; sqlQuery?: string; }; config: Record<string, unknown>; }

Returns

panel is { id: string; type: "vgplot"; title: string; source?: { tableName?: string; sqlQuery?: string }; config: { chartType: "histogram"; settings: { field?: string }; settingsOpen?: boolean } | { chartType: "count-plot"; settings: { field?: string }; settingsOpen?: boolean } | { 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" }[] }; settingsOpen?: boolean } | { chartType: "bubble-chart"; settings: { x?: string; y?: string; size?: string }; settingsOpen?: boolean } | { chartType: "heatmap"; settings: { x?: string; y?: string }; settingsOpen?: boolean } | { chartType: "box-plot"; settings: { x?: string; y?: string }; settingsOpen?: boolean } | { chartType: "custom-spec"; settingsOpen?: boolean; settings: { vgPlotSpec?: unknown } } }