Skip to content

@sqlrooms/pivot / createOrReplacePivotRelations

Function: createOrReplacePivotRelations()

createOrReplacePivotRelations(args): Promise<{ cells?: string; rowTotals?: string; colTotals?: string; grandTotal?: string; export?: string; }>

Parameters

ParameterType
args{ connector: DuckDbConnector; source: PivotQuerySource; config: { rendererName: "Table" | "Table Heatmap" | "Table Col Heatmap" | "Table Row Heatmap" | "Exportable TSV" | "Grouped Column Chart" | "Stacked Column Chart" | "Grouped Bar Chart" | "Stacked Bar Chart" | "Line Chart" | "Dot Chart" | "Area Chart" | "Scatter Chart" | "Multiple Pie Chart"; aggregatorName: string; rows: string[]; cols: string[]; vals: string[]; valueFilter: Record<string, Record<string, boolean>>; rowOrder: "key_a_to_z" | "value_a_to_z" | "value_z_to_a"; colOrder: "key_a_to_z" | "value_a_to_z" | "value_z_to_a"; unusedOrder: string[]; menuLimit: number; hiddenAttributes: string[]; hiddenFromAggregators: string[]; hiddenFromDragDrop: string[]; }; relationBaseName: string; schemaName?: string; signal?: AbortSignal; }
args.connectorDuckDbConnector
args.sourcePivotQuerySource
args.config{ rendererName: "Table" | "Table Heatmap" | "Table Col Heatmap" | "Table Row Heatmap" | "Exportable TSV" | "Grouped Column Chart" | "Stacked Column Chart" | "Grouped Bar Chart" | "Stacked Bar Chart" | "Line Chart" | "Dot Chart" | "Area Chart" | "Scatter Chart" | "Multiple Pie Chart"; aggregatorName: string; rows: string[]; cols: string[]; vals: string[]; valueFilter: Record<string, Record<string, boolean>>; rowOrder: "key_a_to_z" | "value_a_to_z" | "value_z_to_a"; colOrder: "key_a_to_z" | "value_a_to_z" | "value_z_to_a"; unusedOrder: string[]; menuLimit: number; hiddenAttributes: string[]; hiddenFromAggregators: string[]; hiddenFromDragDrop: string[]; }
args.config.rendererName"Table" | "Table Heatmap" | "Table Col Heatmap" | "Table Row Heatmap" | "Exportable TSV" | "Grouped Column Chart" | "Stacked Column Chart" | "Grouped Bar Chart" | "Stacked Bar Chart" | "Line Chart" | "Dot Chart" | "Area Chart" | "Scatter Chart" | "Multiple Pie Chart"
args.config.aggregatorNamestring
args.config.rowsstring[]
args.config.colsstring[]
args.config.valsstring[]
args.config.valueFilterRecord<string, Record<string, boolean>>
args.config.rowOrder"key_a_to_z" | "value_a_to_z" | "value_z_to_a"
args.config.colOrder"key_a_to_z" | "value_a_to_z" | "value_z_to_a"
args.config.unusedOrderstring[]
args.config.menuLimitnumber
args.config.hiddenAttributesstring[]
args.config.hiddenFromAggregatorsstring[]
args.config.hiddenFromDragDropstring[]
args.relationBaseNamestring
args.schemaName?string
args.signal?AbortSignal

Returns

Promise<{ cells?: string; rowTotals?: string; colTotals?: string; grandTotal?: string; export?: string; }>