SamplesGenerator

Plugin: SamplesGenerator

Members

allowDuplicates

Source code

samplesGenerator.allowDuplicates : boolean

true if duplicate samples collection should be allowed, false otherwise.

Default: {false}

customSampleCount

Source code

samplesGenerator.customSampleCount : number

Custom number of samples to take of each value length.

Default: {null}

dataFactory

Source code

samplesGenerator.dataFactory : function

Function which give the data to collect samples.

includeHidden

Source code

samplesGenerator.includeHidden : boolean

true if hidden samples should be included, false otherwise.

Default: {false}

SAMPLE_COUNT

Source code

SamplesGenerator.SAMPLE_COUNT : number

Number of samples to take of each value length.

samples

Source code

samplesGenerator.samples : Map

Samples prepared for calculations.

Default: {null}

Methods

generateColumnSamples

Source code

samplesGenerator.generateColumnSamples(colRange, rowRange) ⇒ object

Generate samples for column. You can control which area should be sampled by passing colRange object and rowRange object.

Param	Type	Description
colRange	object	Column index.
rowRange	object	Column index.

generateRowSamples

Source code

samplesGenerator.generateRowSamples(rowRange, colRange) ⇒ object

Generate samples for row. You can control which area should be sampled by passing rowRange object and colRange object.

Param	Type	Description
rowRange	object number	The rows range to generate the samples.
colRange	object	The column range to generate the samples.

generateSample

Source code

samplesGenerator.generateSample(type, range, specifierValue) ⇒ Map

Generate sample for specified type (row or col).

Param	Type	Description
type	string	Samples type row or col.
range	object	The range to generate the samples.
specifierValue	number	The range to generate the samples.

generateSamples

Source code

samplesGenerator.generateSamples(type, range, specifierRange) ⇒ Map

Generate collection of samples.

Param	Type	Description
type	string	Type to generate. Can be col or row.
range	object	The range to generate the samples.
specifierRange	object number	The range to generate the samples.

getSampleCount

Source code

samplesGenerator.getSampleCount() ⇒ number

Get the sample count for this instance.

setAllowDuplicates

Source code

samplesGenerator.setAllowDuplicates(allowDuplicates)

Set if the generator should accept duplicate values.

Param	Type	Description
allowDuplicates	boolean	true to allow duplicate values.

setIncludeHidden

Source code

samplesGenerator.setIncludeHidden(includeHidden)

Sets the sampler to the mode where it will generate samples for hidden indexes.

Param	Type	Description
includeHidden	boolean	true to include hidden indexes, false otherwise.

setSampleCount

Source code

samplesGenerator.setSampleCount(sampleCount)

Set the sample count.

Param	Type	Description
sampleCount	number	Number of samples to be collected.