# packages/core/src/features/viz/lib/bar-fill.ts
This is the source snapshot used to build these API details. [View this revision on GitHub](https://github.com/benlesh/pibbl/blob/272a94aaf62e0bd6ad8726a4c607a76a9ec44ca1/packages/core/src/features/viz/lib/bar-fill.ts#L9).

[Back to reference](/reference/components/bar-series/)

<pre class="api-source"><code><span id="L1"><a href="#L1" aria-label="Line 1">1</a> import type { BarSeriesStyle } from './bar-series.js';</span>
<span id="L2"><a href="#L2" aria-label="Line 2">2</a> import type { FillStyle } from &quot;@pibbl/core&quot;;</span>
<span id="L3"><a href="#L3" aria-label="Line 3">3</a> </span>
<span id="L4"><a href="#L4" aria-label="Line 4">4</a> /**</span>
<span id="L5"><a href="#L5" aria-label="Line 5">5</a>  * Domain thresholds divide the bar fill into sharp, ordered color intervals.</span>
<span id="L6"><a href="#L6" aria-label="Line 6">6</a>  *</span>
<span id="L7"><a href="#L7" aria-label="Line 7">7</a>  * @see {@link BarSeriesStyle}</span>
<span id="L8"><a href="#L8" aria-label="Line 8">8</a>  */</span>
<span id="L9"><a href="#L9" aria-label="Line 9">9</a> export interface BarThresholdFill {</span>
<span id="L10"><a href="#L10" aria-label="Line 10">10</a>   /** The literal &quot;threshold&quot; identifying this variant. See {@link BarThresholdFill}. */</span>
<span id="L11"><a href="#L11" aria-label="Line 11">11</a>   readonly type: &quot;threshold&quot;;</span>
<span id="L12"><a href="#L12" aria-label="Line 12">12</a>   /** Ordered numeric boundaries separating fill-color intervals. See {@link BarThresholdFill}. */</span>
<span id="L13"><a href="#L13" aria-label="Line 13">13</a>   readonly thresholds: readonly number[];</span>
<span id="L14"><a href="#L14" aria-label="Line 14">14</a>   /** Colors assigned to successive threshold intervals. See {@link BarThresholdFill}. */</span>
<span id="L15"><a href="#L15" aria-label="Line 15">15</a>   readonly colors: readonly string[];</span>
<span id="L16"><a href="#L16" aria-label="Line 16">16</a> }</span>
<span id="L17"><a href="#L17" aria-label="Line 17">17</a> </span>
<span id="L18"><a href="#L18" aria-label="Line 18">18</a> export function barFill(</span>
<span id="L19"><a href="#L19" aria-label="Line 19">19</a>   ctx: Pick&lt;CanvasRenderingContext2D, &quot;createLinearGradient&quot;&gt;,</span>
<span id="L20"><a href="#L20" aria-label="Line 20">20</a>   fill: FillStyle | BarThresholdFill,</span>
<span id="L21"><a href="#L21" aria-label="Line 21">21</a>   map: (value: number) =&gt; number,</span>
<span id="L22"><a href="#L22" aria-label="Line 22">22</a>   orientation: &quot;vertical&quot; | &quot;horizontal&quot;,</span>
<span id="L23"><a href="#L23" aria-label="Line 23">23</a> ): (start: number, end: number) =&gt; FillStyle {</span>
<span id="L24"><a href="#L24" aria-label="Line 24">24</a>   if (</span>
<span id="L25"><a href="#L25" aria-label="Line 25">25</a>     typeof fill === &quot;string&quot; ||</span>
<span id="L26"><a href="#L26" aria-label="Line 26">26</a>     fill instanceof CanvasGradient ||</span>
<span id="L27"><a href="#L27" aria-label="Line 27">27</a>     fill instanceof CanvasPattern</span>
<span id="L28"><a href="#L28" aria-label="Line 28">28</a>   )</span>
<span id="L29"><a href="#L29" aria-label="Line 29">29</a>     return () =&gt; fill;</span>
<span id="L30"><a href="#L30" aria-label="Line 30">30</a>   if (fill &amp;&amp; !(&quot;type&quot; in fill)) return () =&gt; fill;</span>
<span id="L31"><a href="#L31" aria-label="Line 31">31</a>   if (!fill || fill.type !== &quot;threshold&quot;)</span>
<span id="L32"><a href="#L32" aria-label="Line 32">32</a>     throw new TypeError(&quot;BarSeries fill must be a paint or a threshold fill.&quot;);</span>
<span id="L33"><a href="#L33" aria-label="Line 33">33</a>   const { thresholds, colors } = fill;</span>
<span id="L34"><a href="#L34" aria-label="Line 34">34</a>   if (</span>
<span id="L35"><a href="#L35" aria-label="Line 35">35</a>     !Array.isArray(thresholds) ||</span>
<span id="L36"><a href="#L36" aria-label="Line 36">36</a>     !Array.isArray(colors) ||</span>
<span id="L37"><a href="#L37" aria-label="Line 37">37</a>     colors.length !== thresholds.length + 1</span>
<span id="L38"><a href="#L38" aria-label="Line 38">38</a>   )</span>
<span id="L39"><a href="#L39" aria-label="Line 39">39</a>     throw new TypeError(</span>
<span id="L40"><a href="#L40" aria-label="Line 40">40</a>       &quot;BarSeries threshold fill requires one more color than thresholds.&quot;,</span>
<span id="L41"><a href="#L41" aria-label="Line 41">41</a>     );</span>
<span id="L42"><a href="#L42" aria-label="Line 42">42</a>   for (let i = 0; i &lt; thresholds.length; i++) {</span>
<span id="L43"><a href="#L43" aria-label="Line 43">43</a>     if (</span>
<span id="L44"><a href="#L44" aria-label="Line 44">44</a>       typeof thresholds[i] !== &quot;number&quot; ||</span>
<span id="L45"><a href="#L45" aria-label="Line 45">45</a>       !Number.isFinite(thresholds[i]) ||</span>
<span id="L46"><a href="#L46" aria-label="Line 46">46</a>       (i &gt; 0 &amp;&amp; thresholds[i] &lt;= thresholds[i - 1])</span>
<span id="L47"><a href="#L47" aria-label="Line 47">47</a>     )</span>
<span id="L48"><a href="#L48" aria-label="Line 48">48</a>       throw new RangeError(</span>
<span id="L49"><a href="#L49" aria-label="Line 49">49</a>         &quot;BarSeries fill thresholds must be finite and strictly increasing.&quot;,</span>
<span id="L50"><a href="#L50" aria-label="Line 50">50</a>       );</span>
<span id="L51"><a href="#L51" aria-label="Line 51">51</a>   }</span>
<span id="L52"><a href="#L52" aria-label="Line 52">52</a>   // Validate even colors whose intervals are not present in the current data.</span>
<span id="L53"><a href="#L53" aria-label="Line 53">53</a>   const validation = ctx.createLinearGradient(0, 0, 0, 1);</span>
<span id="L54"><a href="#L54" aria-label="Line 54">54</a>   for (const color of colors) {</span>
<span id="L55"><a href="#L55" aria-label="Line 55">55</a>     if (typeof color !== &quot;string&quot;)</span>
<span id="L56"><a href="#L56" aria-label="Line 56">56</a>       throw new TypeError(</span>
<span id="L57"><a href="#L57" aria-label="Line 57">57</a>         &quot;BarSeries threshold colors must be CSS color strings.&quot;,</span>
<span id="L58"><a href="#L58" aria-label="Line 58">58</a>       );</span>
<span id="L59"><a href="#L59" aria-label="Line 59">59</a>     validation.addColorStop(0, color);</span>
<span id="L60"><a href="#L60" aria-label="Line 60">60</a>   }</span>
<span id="L61"><a href="#L61" aria-label="Line 61">61</a>   return (start, end) =&gt; {</span>
<span id="L62"><a href="#L62" aria-label="Line 62">62</a>     const low = Math.min(start, end),</span>
<span id="L63"><a href="#L63" aria-label="Line 63">63</a>       high = Math.max(start, end);</span>
<span id="L64"><a href="#L64" aria-label="Line 64">64</a>     let index = 0;</span>
<span id="L65"><a href="#L65" aria-label="Line 65">65</a>     while (index &lt; thresholds.length &amp;&amp; thresholds[index] &lt;= low) index++;</span>
<span id="L66"><a href="#L66" aria-label="Line 66">66</a>     const valueStart = map(low),</span>
<span id="L67"><a href="#L67" aria-label="Line 67">67</a>       valueEnd = map(high);</span>
<span id="L68"><a href="#L68" aria-label="Line 68">68</a>     if (valueStart === valueEnd) return colors[index];</span>
<span id="L69"><a href="#L69" aria-label="Line 69">69</a>     // Rectangle placement translates its local paint coordinates.</span>
<span id="L70"><a href="#L70" aria-label="Line 70">70</a>     const origin = Math.min(valueStart, valueEnd);</span>
<span id="L71"><a href="#L71" aria-label="Line 71">71</a>     const gradient = orientation === &quot;vertical&quot;</span>
<span id="L72"><a href="#L72" aria-label="Line 72">72</a>       ? ctx.createLinearGradient(0, valueStart - origin, 0, valueEnd - origin)</span>
<span id="L73"><a href="#L73" aria-label="Line 73">73</a>       : ctx.createLinearGradient(valueStart - origin, 0, valueEnd - origin, 0);</span>
<span id="L74"><a href="#L74" aria-label="Line 74">74</a>     gradient.addColorStop(0, colors[index]);</span>
<span id="L75"><a href="#L75" aria-label="Line 75">75</a>     for (; index &lt; thresholds.length &amp;&amp; thresholds[index] &lt; high; index++) {</span>
<span id="L76"><a href="#L76" aria-label="Line 76">76</a>       const offset = Math.max(</span>
<span id="L77"><a href="#L77" aria-label="Line 77">77</a>         0,</span>
<span id="L78"><a href="#L78" aria-label="Line 78">78</a>         Math.min(</span>
<span id="L79"><a href="#L79" aria-label="Line 79">79</a>           1,</span>
<span id="L80"><a href="#L80" aria-label="Line 80">80</a>           (map(thresholds[index]) - valueStart) / (valueEnd - valueStart),</span>
<span id="L81"><a href="#L81" aria-label="Line 81">81</a>         ),</span>
<span id="L82"><a href="#L82" aria-label="Line 82">82</a>       );</span>
<span id="L83"><a href="#L83" aria-label="Line 83">83</a>       gradient.addColorStop(offset, colors[index]);</span>
<span id="L84"><a href="#L84" aria-label="Line 84">84</a>       gradient.addColorStop(offset, colors[index + 1]);</span>
<span id="L85"><a href="#L85" aria-label="Line 85">85</a>     }</span>
<span id="L86"><a href="#L86" aria-label="Line 86">86</a>     gradient.addColorStop(1, colors[index]);</span>
<span id="L87"><a href="#L87" aria-label="Line 87">87</a>     return gradient;</span>
<span id="L88"><a href="#L88" aria-label="Line 88">88</a>   };</span>
<span id="L89"><a href="#L89" aria-label="Line 89">89</a> }</span>
<span id="L90"><a href="#L90" aria-label="Line 90">90</a> </span></code></pre>

## Documentation version

Documentation built with @pibbl/core 0.0.2, revision 272a94a. ALPHA — NOT FOR PRODUCTION USE.
