Skip to content

@sqlrooms/mosaic / createMosaicDashboardVgPlotPanelConfig

Function: createMosaicDashboardVgPlotPanelConfig()

createMosaicDashboardVgPlotPanelConfig(title, config, source?): object

Parameters

ParameterType
titlestring
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; }; }
source?{ tableName?: string; sqlQuery?: string; }
source.tableName?string
source.sqlQuery?string

Returns

object

NameTypeDefault value
idstring-
type"vgplot"-
titlestring-
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; }; }VgPlotChartConfig