# C1.WPF.Chart.Heatmap

## Content

<div class="doc-site-dotnet-api-container">



  <h1 id="C1_WPF_Chart_Heatmap" data-uid="C1.WPF.Chart.Heatmap" class="text-break">Heatmap Class
</h1>
  <div class="markdown level0 summary"><p>Represents heatmap series that displays 2D data array using color variations.</p>
</div>
  <div class="markdown level0 conceptual"></div>
  <div class="inheritance">
    <h5>Inheritance</h5>
    <div class="level0"><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></div>
    <div class="level1"><a class="xref" href="C1.WPF.Chart.Series.html">Series</a></div>
    <div class="level2"><span class="xref">Heatmap</span></div>
      <div class="level3"><a class="xref" href="C1.WPF.Chart.Contour.html">Contour</a></div>
  </div>
  <div class="implements">
    <h5>Implements</h5>
    <div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.idisposable">IDisposable</a></div>
    <div><span class="xref">IValueProvider</span></div>
    <div><span class="xref">ISeries</span></div>
    <div><span class="xref">IStyleProvider</span></div>
    <div><span class="xref">IHeatmap</span></div>
    <div><span class="xref">IAxesProvider</span></div>
  </div>
  <h6><strong>Namespace</strong>: <a class="xref" href="C1.WPF.Chart.html">C1.WPF.Chart</a></h6>
  <h6><strong>Assembly</strong>: C1.WPF.Chart.dll</h6>
  <h5 id="C1_WPF_Chart_Heatmap_syntax">Syntax</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public class Heatmap : Series, IDisposable, IValueProvider, ISeries, IStyleProvider, IHeatmap, IAxesProvider</code></pre>
  </div>
  <div class="codewrapper">
    <pre><code class="lang-vbnet hljs">Public Class Heatmap
    Inherits Series
    Implements IDisposable, IValueProvider, ISeries, IStyleProvider, IHeatmap, IAxesProvider</code></pre>
  </div>
  <h5 id="C1_WPF_Chart_Heatmap_examples"><strong>Examples</strong></h5>
  <p>The following code creates heatmap series and add it to the chart.</p>
<pre><code class="lang-csharp">var hmap = new Heatmap();
hmap.ItemsSource = new double [,] { { 0, 0.5 }, {0.5, 1 }, { 1, 0.4 }, { 0.5, 1 } };
hmap.ColorScale = new GradientColorScale() { Min = 0, Max = 1, Colors = new List&lt;Color&gt; { Color.White, Color.Red } };
chart.Series.Add(hmap);
chart.AxisX.ItemsSource = new string[] {"Q1", "Q2", "Q3", "Q4" };
chart.AxisY.ItemsSource = new string[] { "Region 1", "Region 2" };</code></pre>

  <h3 id="constructors">Constructors
</h3>
  <table class="table table-bordered table-condensed">
    <thead>
      <tr>
        <th>Name</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td id="C1_WPF_Chart_Heatmap__ctor" data-uid="C1.WPF.Chart.Heatmap.#ctor">
          <a class="xref" href="C1.WPF.Chart.Heatmap.-ctor.html#C1_WPF_Chart_Heatmap__ctor">Heatmap()</a>
        </td>
        <td class="markdown level1 summary"><p>Creates an instance of Heatmap class.</p>
</td>
      </tr>
    </tbody>
  </table>
  <h3 id="fields">Fields
</h3>
  <table class="table table-bordered table-condensed">
    <thead>
      <tr>
        <th>Name</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td id="C1_WPF_Chart_Heatmap_ColorScaleProperty" data-uid="C1.WPF.Chart.Heatmap.ColorScaleProperty">
          <a class="xref" href="C1.WPF.Chart.Heatmap.ColorScaleProperty.html">ColorScaleProperty</a>
        </td>
        <td class="markdown level1 summary"><p>Identifies the ColorScaleProperty dependency property.</p>
</td>
      </tr>
      <tr>
        <td id="C1_WPF_Chart_Heatmap_StartXProperty" data-uid="C1.WPF.Chart.Heatmap.StartXProperty">
          <a class="xref" href="C1.WPF.Chart.Heatmap.StartXProperty.html">StartXProperty</a>
        </td>
        <td class="markdown level1 summary"><p>Identifies the StartXProperty dependency property.</p>
</td>
      </tr>
      <tr>
        <td id="C1_WPF_Chart_Heatmap_StartYProperty" data-uid="C1.WPF.Chart.Heatmap.StartYProperty">
          <a class="xref" href="C1.WPF.Chart.Heatmap.StartYProperty.html">StartYProperty</a>
        </td>
        <td class="markdown level1 summary"><p>Identifies the StartYProperty dependency property.</p>
</td>
      </tr>
      <tr>
        <td id="C1_WPF_Chart_Heatmap_StepXProperty" data-uid="C1.WPF.Chart.Heatmap.StepXProperty">
          <a class="xref" href="C1.WPF.Chart.Heatmap.StepXProperty.html">StepXProperty</a>
        </td>
        <td class="markdown level1 summary"><p>Identifies the StepXProperty dependency property.</p>
</td>
      </tr>
      <tr>
        <td id="C1_WPF_Chart_Heatmap_StepYProperty" data-uid="C1.WPF.Chart.Heatmap.StepYProperty">
          <a class="xref" href="C1.WPF.Chart.Heatmap.StepYProperty.html">StepYProperty</a>
        </td>
        <td class="markdown level1 summary"><p>Identifies the StepYProperty dependency property.</p>
</td>
      </tr>
    </tbody>
  </table>
  <h3 id="properties">Properties
</h3>
  <table class="table table-bordered table-condensed">
    <thead>
      <tr>
        <th>Name</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td id="C1_WPF_Chart_Heatmap_ColorScale" data-uid="C1.WPF.Chart.Heatmap.ColorScale">
          <a class="xref" href="C1.WPF.Chart.Heatmap.ColorScale.html#C1_WPF_Chart_Heatmap_ColorScale">ColorScale</a>
        </td>
        <td class="markdown level1 summary"><p>Gets or sets the color scale for the heatmap. The color scale defines trasformation from data value to color.</p>
</td>
      </tr>
      <tr>
        <td id="C1_WPF_Chart_Heatmap_StartX" data-uid="C1.WPF.Chart.Heatmap.StartX">
          <a class="xref" href="C1.WPF.Chart.Heatmap.StartX.html#C1_WPF_Chart_Heatmap_StartX">StartX</a>
        </td>
        <td class="markdown level1 summary"><p>Gets or sets the starting data x-value. The default value is -0.5.</p>
</td>
      </tr>
      <tr>
        <td id="C1_WPF_Chart_Heatmap_StartY" data-uid="C1.WPF.Chart.Heatmap.StartY">
          <a class="xref" href="C1.WPF.Chart.Heatmap.StartY.html#C1_WPF_Chart_Heatmap_StartY">StartY</a>
        </td>
        <td class="markdown level1 summary"><p>Gets or sets the starting data y-value. The default value is -0.5.</p>
</td>
      </tr>
      <tr>
        <td id="C1_WPF_Chart_Heatmap_StepX" data-uid="C1.WPF.Chart.Heatmap.StepX">
          <a class="xref" href="C1.WPF.Chart.Heatmap.StepX.html#C1_WPF_Chart_Heatmap_StepX">StepX</a>
        </td>
        <td class="markdown level1 summary"><p>Gets or sets the data step by x-coordinate. The default value is 1.</p>
</td>
      </tr>
      <tr>
        <td id="C1_WPF_Chart_Heatmap_StepY" data-uid="C1.WPF.Chart.Heatmap.StepY">
          <a class="xref" href="C1.WPF.Chart.Heatmap.StepY.html#C1_WPF_Chart_Heatmap_StepY">StepY</a>
        </td>
        <td class="markdown level1 summary"><p>Gets or sets the data step by y-coordinate. The default value is 1.</p>
</td>
      </tr>
    </tbody>
  </table>
  <h3 id="methods">Methods
</h3>
  <table class="table table-bordered table-condensed">
    <thead>
      <tr>
        <th>Name</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td id="C1_WPF_Chart_Heatmap_GetChartType" data-uid="C1.WPF.Chart.Heatmap.GetChartType">
          <a class="xref" href="C1.WPF.Chart.Heatmap.GetChartType.html#C1_WPF_Chart_Heatmap_GetChartType">GetChartType()</a>
        </td>
        <td class="markdown level1 summary"><p>Gets the series chart type.</p>
</td>
      </tr>
      <tr>
        <td id="C1_WPF_Chart_Heatmap_GetItem_System_Int32_" data-uid="C1.WPF.Chart.Heatmap.GetItem(System.Int32)">
          <a class="xref" href="C1.WPF.Chart.Heatmap.GetItem.html#C1_WPF_Chart_Heatmap_GetItem_System_Int32_">GetItem(int)</a>
        </td>
        <td class="markdown level1 summary"><p>Gets the series data item by index.</p>
</td>
      </tr>
      <tr>
        <td id="C1_WPF_Chart_Heatmap_GetValues_System_Int32_" data-uid="C1.WPF.Chart.Heatmap.GetValues(System.Int32)">
          <a class="xref" href="C1.WPF.Chart.Heatmap.GetValues.html#C1_WPF_Chart_Heatmap_GetValues_System_Int32_">GetValues(int)</a>
        </td>
        <td class="markdown level1 summary"><p>Gets the series data values.</p>
</td>
      </tr>
      <tr>
        <td id="C1_WPF_Chart_Heatmap_OnRendering_C1_Chart_IRenderEngine_" data-uid="C1.WPF.Chart.Heatmap.OnRendering(C1.Chart.IRenderEngine)">
          <a class="xref" href="C1.WPF.Chart.Heatmap.OnRendering.html#C1_WPF_Chart_Heatmap_OnRendering_C1_Chart_IRenderEngine_">OnRendering(IRenderEngine)</a>
        </td>
        <td class="markdown level1 summary"><p>Called before series is rendered.</p>
</td>
      </tr>
    </tbody>
  </table>

</div>
