Skip to content

@sqlrooms/deck / resolveDeckMapDashboardDatasetSource

Function: resolveDeckMapDashboardDatasetSource()

resolveDeckMapDashboardDatasetSource(options): { tableName?: string; sqlQuery?: string; } | undefined

Parameters

ParameterType
options{ dashboard: { id: string; title: string; layoutType: "grid" | "dock"; selectedTable?: string; panels: ({ 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: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodUnknown>>; })[]; layout: LayoutNode | null; updatedAt: number; }; 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: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodUnknown>>; }; dataset?: DeckMapDashboardDatasetConfig; }
options.dashboard{ id: string; title: string; layoutType: "grid" | "dock"; selectedTable?: string; panels: ({ 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: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodUnknown>>; })[]; layout: LayoutNode | null; updatedAt: number; }
options.dashboard.idstring
options.dashboard.titlestring
options.dashboard.layoutType"grid" | "dock"
options.dashboard.selectedTable?string
options.dashboard.panels({ 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: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodUnknown>>; })[]
options.dashboard.layoutLayoutNode | null
options.dashboard.updatedAtnumber
options.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: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodUnknown>>; }
options.dataset?DeckMapDashboardDatasetConfig

Returns

{ tableName?: string; sqlQuery?: string; } | undefined