sample({options})

Sample cell as the {r, g, b, a, total} object literal. Used by the sort algorithm. For instance LUMA sorting is implemented as follows:

// excerpt from sort
let memory1D = this.toArray();
// ...
memory1D.sort((valueA, valueB) => {
  let sa = Quadrille.sample({ value: valueA, background,
                              cellLength, textColor, textZoom });
  let sb = Quadrille.sample({ value: valueB, background,
                              cellLength, textColor, textZoom });
  let wa = 0.299 * sa.r + 0.587 * sa.g + 0.114 * sa.b;
  let wb = 0.299 * sb.r + 0.587 * sb.g + 0.114 * sb.b;
  return wa - wb;
});

Use this method to implementing other sorting criteria of the quadrille cells.

Syntax #

sample([{value, imageDisplay, colorDisplay, booleanDisplay, numberDisplay, bigintDisplay, stringDisplay, symbolDisplay, arrayDisplay, objectDisplay, background, cellLength, outlineWeight, outline, textColor, textZoom}])

Parameters #

ParamDescription
valueAny valid JavaScript value
imageDisplayFunction: image filled cell drawing custom procedure. Default is Quadrille.imageDisplay
colorDisplayFunction: color filled cell drawing custom procedure. Default is Quadrille.colorDisplay
booleanDisplayFunction: boolean filled cell drawing custom procedure. Default is Quadrille.booleanDisplay
numberDisplayFunction: number filled cell drawing custom procedure. Default is Quadrille.numberDisplay
bigintDisplayFunction: bigint filled cell drawing custom procedure. Default is Quadrille.bigintDisplay
stringDisplayFunction: string filled cell drawing custom procedure. Default is Quadrille.stringDisplay
symbolDisplayFunction: symbol filled cell drawing custom procedure. No static default provided
arrayDisplayFunction: array filled cell drawing custom procedure. No static default provided
objectDisplayFunction: object filled cell drawing custom procedure. No static default provided
backgroundp5.Color: background sampling default is Quadrille.background, which is set to white
cellLengthNumber: cell sampling length. Default is quadrille width
outlineWeightNumber: edge weight. Default is Quadrille.outlineWeight. Use 0 to discard all edges
outlinep5.Color: edge color. Default is Quadrille.outline
textColorp5.Color: text sampling color. Default is Quadrille.textColor
textZoomNumber: text zoom level. Default is Quadrille.textZoom