composition-plot

Home > composition-plot > samplePositionFnFactory

samplePositionFnFactory() function

Helper function that returns a for a set of predefined plot layouts.

Signature:

export declare function samplePositionFnFactory(plotType: PlotTypes, verticesFn: VerticesFn, scales: Scale[], edge: number, dp: DataProvider): SamplePositionFn;

Parameters

Parameter Type Description
plotType PlotTypes The layout of the composition plot
verticesFn VerticesFn The VerticesFn of the plot
scales Scale[] The scaling function mapping composition fraction to edge fraction
edge number The size of the plot edge
dp DataProvider The DataProvider of the plot

Returns:

SamplePositionFn

A SamplePositionFn