Skip to main content
torch.js has not been released yet.
torch.js logotorch.js logotorch.js
PlaygroundContact
Login
Documentation
IntroductionType SafetyTensor ExpressionsTensor IndexingEinsumEinopsAutogradTraining a ModelProfiling & MemoryPyTorch MigrationBest PracticesRuntimesPerformancePyTorch CompatibilityBenchmarksDType Coverage
IntroductionRenderer GalleryRenderersAnalysis
createAttentionFlowRendererAttentionFlowRendererAttentionFlowRenderer.renderAttentionFlowRenderer.renderToCanvasAttentionFlowRenderer.renderToBlobAttentionFlowRenderer.destroyAttentionFlowOptionscomputeBoxPlotStatscreateBoxPlotRendererBoxPlotRendererBoxPlotRenderer.renderBoxPlotRenderer.renderToCanvasBoxPlotRenderer.destroyBoxPlotStatsBoxPlotOptionscreateConfusionMatrixRenderercomputeConfusionMatrixConfusionMatrixRendererConfusionMatrixRenderer.renderConfusionMatrixRenderer.renderToCanvasConfusionMatrixRenderer.destroyNormalizationModeConfusionMatrixOptionscomputeROCCurvecomputePRCurvecreateCurveRendererCurveRendererCurveRenderer.renderROCCurveRenderer.renderPRCurveRenderer.renderROCToCanvasCurveRenderer.renderPRToCanvasCurveRenderer.renderROCToBlobCurveRenderer.destroyCurveTypeCurvePointCurveDataCurveResultCurveOptionscreateDendrogramRendererDendrogramRendererDendrogramRenderer.renderDendrogramRenderer.renderToCanvasDendrogramRenderer.destroyDendrogramOptionscreateEmbeddingRendererEmbeddingRendererEmbeddingRenderer.renderEmbeddingRenderer.renderPCAEmbeddingRenderer.renderTSNEEmbeddingRenderer.renderKMeansEmbeddingRenderer.renderToCanvasEmbeddingRenderer.renderToTextureEmbeddingRenderer.renderToBlobEmbeddingRenderer.destroyEmbeddingColorModeLegendPositionEmbeddingCameraCategoryLabelEmbeddingOptionsEmbeddingRenderResultcreateFeatureMapGridRendererFeatureMapGridRendererFeatureMapGridRenderer.renderFeatureMapGridRenderer.renderAutoRangeFeatureMapGridRenderer.renderToCanvasAutoRangeFeatureMapGridRenderer.renderToBlobFeatureMapGridRenderer.destroyFeatureMapGridOptionscreateGradientFlowRendererGradientFlowRendererGradientFlowRenderer.renderGradientFlowRenderer.renderToCanvasGradientFlowRenderer.destroyLayerGradientStatsGradientFlowOptionscreateHeatmapRendererHeatmapRendererHeatmapRenderer.renderHeatmapRenderer.renderAutoRangeHeatmapRenderer.renderToCanvasHeatmapRenderer.renderToCanvasAutoRangeHeatmapRenderer.renderToTextureHeatmapRenderer.renderToBlobHeatmapRenderer.renderToDataURLHeatmapRenderer.destroyHeatmapOptionscreateHistogramRendererHistogramRendererHistogramRenderer.renderHistogramRenderer.renderFromHistogramHistogramRenderer.renderToCanvasHistogramRenderer.destroyHistogramOptionscreateKernelGridRendererKernelGridRendererKernelGridRenderer.renderKernelGridRenderer.renderToCanvasKernelGridRenderer.destroyKernelGridOptionscreateLineChartRenderercreateStreamingLineChartLineChartRendererLineChartRenderer.renderLineChartRenderer.renderToCanvasLineChartRenderer.renderToTextureLineChartRenderer.renderToBlobLineChartRenderer.destroyStreamingLineChartStreamingLineChart.appendStreamingLineChart.appendToSeriesStreamingLineChart.clearStreamingLineChart.renderToCanvasStreamingLineChart.renderStreamingLineChart.destroySeriesColorLineChartSeriesLineChartOptionscreateModelArchitectureRenderercreateSequentialGraphModelArchitectureRendererModelArchitectureRenderer.renderModelArchitectureRenderer.renderToCanvasModelArchitectureRenderer.destroyLayerTypeArchitectureNodeArchitectureEdgeArchitectureGraphArchitectureOptionscreateNetworkGraphRenderergraphFromAdjacencyMatrixNetworkGraphRendererNetworkGraphRenderer.renderNetworkGraphRenderer.renderToCanvasNetworkGraphRenderer.destroyGraphNodeGraphEdgeGraphDataNetworkGraphOptionscreatePointCloudRendererPointCloudRendererPointCloudRenderer.renderPointCloudRenderer.renderToCanvasPointCloudRenderer.renderToTexturePointCloudRenderer.renderToBlobPointCloudRenderer.destroyCamera3DPointCloudOptionscreateSaliencyMapRendererSaliencyMapRendererSaliencyMapRenderer.renderSaliencyMapRenderer.renderToCanvasSaliencyMapRenderer.destroySaliencyColormapSaliencyMapDataSaliencyMapOptionscreateSankeyRendererSankeyRendererSankeyRenderer.renderSankeyRenderer.renderToCanvasSankeyRenderer.destroySankeyNodeSankeyLinkSankeyDataSankeyOptionscreateTrainingDashboardTrainingDashboardTrainingDashboard.logTrainingDashboard.logMetricTrainingDashboard.renderTrainingDashboard.getMetricsTrainingDashboard.getMetricTrainingDashboard.getCurrentStepTrainingDashboard.clearTrainingDashboard.exportMetricsTrainingDashboard.importMetricsTrainingDashboard.destroyMetricPointMetricSeriesChartPanelConfigDashboardLayoutTrainingDashboardOptionsTrainingSnapshot
torch.js· 2026
LegalTerms of UsePrivacy Policy
/
/
  1. docs
  2. viz
  3. viz
  4. renderers
  5. SankeyOptions

viz.renderers.SankeyOptions

export interface SankeyOptions {
  /** Render target */
  target?: RenderTarget;
  /** Chart title */
  title?: string;
  /** Node width in pixels (default: 20) */
  nodeWidth?: number;
  /** Padding between nodes (default: 10) */
  nodePadding?: number;
  /** Number of layout iterations (default: 32) */
  iterations?: number;
  /** Default node color */
  nodeColor?: [number, number, number];
  /** Default link color */
  linkColor?: [number, number, number, number];
  /** Show link labels (default: false) */
  showLinkLabels?: boolean;
  /** Show node labels (default: true) */
  showNodeLabels?: boolean;
  /** Label font size (default: 11) */
  labelSize?: number;
  /** Background color */
  backgroundColor?: [number, number, number, number];
}
target(RenderTarget)optional
– Render target
title(string)optional
– Chart title
nodeWidth(number)optional
– Node width in pixels (default: 20)
nodePadding(number)optional
– Padding between nodes (default: 10)
iterations(number)optional
– Number of layout iterations (default: 32)
nodeColor([number, number, number])optional
– Default node color
linkColor([number, number, number, number])optional
– Default link color
showLinkLabels(boolean)optional
– Show link labels (default: false)
showNodeLabels(boolean)optional
– Show node labels (default: true)
labelSize(number)optional
– Label font size (default: 11)
backgroundColor([number, number, number, number])optional
– Background color

Options for Sankey diagram rendering.

Previous
SankeyNode
Next
SankeyRenderer