Add style object to dashboard widget formulas (#1266)

Co-authored-by: ci.datadog-api-spec <[email protected]> 7a7be3c

_sources/datadog_api_client.v1.model.rst.txt

@@ -5167,6 +5167,13 @@ widget\_formula\_limit
    :members:
    :show-inheritance:
 
+widget\_formula\_style
+----------------------
+
+.. automodule:: datadog_api_client.v1.model.widget_formula_style
+   :members:
+   :show-inheritance:
+
 widget\_grouping
 ----------------
 

datadog_api_client.html

@@ -4117,6 +4117,10 @@ <h1 id="datadog-api-client--page-root">datadog_api_client<a class="headerlink" h
 <li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v1.model.html#datadog_api_client.v1.model.widget_formula_limit.WidgetFormulaLimit"><code class="docutils literal notranslate"><span class="pre">WidgetFormulaLimit</span></code></a></li>
 </ul>
 </li>
+<li class="toctree-l3"><a class="reference internal" href="datadog_api_client.v1.model.html#module-datadog_api_client.v1.model.widget_formula_style">widget_formula_style</a><ul>
+<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v1.model.html#datadog_api_client.v1.model.widget_formula_style.WidgetFormulaStyle"><code class="docutils literal notranslate"><span class="pre">WidgetFormulaStyle</span></code></a></li>
+</ul>
+</li>
 <li class="toctree-l3"><a class="reference internal" href="datadog_api_client.v1.model.html#module-datadog_api_client.v1.model.widget_grouping">widget_grouping</a><ul>
 <li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v1.model.html#datadog_api_client.v1.model.widget_grouping.WidgetGrouping"><code class="docutils literal notranslate"><span class="pre">WidgetGrouping</span></code></a></li>
 </ul>

datadog_api_client.v1.html

@@ -4031,6 +4031,10 @@ <h1 id="datadog-api-client-v1--page-root">datadog_api_client.v1<a class="headerl
 <li class="toctree-l3"><a class="reference internal" href="datadog_api_client.v1.model.html#datadog_api_client.v1.model.widget_formula_limit.WidgetFormulaLimit"><code class="docutils literal notranslate"><span class="pre">WidgetFormulaLimit</span></code></a></li>
 </ul>
 </li>
+<li class="toctree-l2"><a class="reference internal" href="datadog_api_client.v1.model.html#module-datadog_api_client.v1.model.widget_formula_style">widget_formula_style</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="datadog_api_client.v1.model.html#datadog_api_client.v1.model.widget_formula_style.WidgetFormulaStyle"><code class="docutils literal notranslate"><span class="pre">WidgetFormulaStyle</span></code></a></li>
+</ul>
+</li>
 <li class="toctree-l2"><a class="reference internal" href="datadog_api_client.v1.model.html#module-datadog_api_client.v1.model.widget_grouping">widget_grouping</a><ul>
 <li class="toctree-l3"><a class="reference internal" href="datadog_api_client.v1.model.html#datadog_api_client.v1.model.widget_grouping.WidgetGrouping"><code class="docutils literal notranslate"><span class="pre">WidgetGrouping</span></code></a></li>
 </ul>

datadog_api_client.v1.model.html

@@ -4675,6 +4675,12 @@
         </li></ul>
             </nav>
         </li>
+        <li class="md-nav__item"><a href="#module-datadog_api_client.v1.model.widget_formula_style" class="md-nav__link">widget_formula_style</a><nav class="md-nav">
+              <ul class="md-nav__list">
+        <li class="md-nav__item"><a href="#datadog_api_client.v1.model.widget_formula_style.WidgetFormulaStyle" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">WidgetFormulaStyle</span></code></a>
+        </li></ul>
+            </nav>
+        </li>
         <li class="md-nav__item"><a href="#module-datadog_api_client.v1.model.widget_grouping" class="md-nav__link">widget_grouping</a><nav class="md-nav">
               <ul class="md-nav__list">
         <li class="md-nav__item"><a href="#datadog_api_client.v1.model.widget_grouping.WidgetGrouping" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">WidgetGrouping</span></code></a>
@@ -9692,6 +9698,12 @@
         </li></ul>
             </nav>
         </li>
+        <li class="md-nav__item"><a href="#module-datadog_api_client.v1.model.widget_formula_style" class="md-nav__link">widget_formula_style</a><nav class="md-nav">
+              <ul class="md-nav__list">
+        <li class="md-nav__item"><a href="#datadog_api_client.v1.model.widget_formula_style.WidgetFormulaStyle" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">WidgetFormulaStyle</span></code></a>
+        </li></ul>
+            </nav>
+        </li>
         <li class="md-nav__item"><a href="#module-datadog_api_client.v1.model.widget_grouping" class="md-nav__link">widget_grouping</a><nav class="md-nav">
               <ul class="md-nav__list">
         <li class="md-nav__item"><a href="#datadog_api_client.v1.model.widget_grouping.WidgetGrouping" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">WidgetGrouping</span></code></a>
@@ -26403,6 +26415,7 @@ <h1 id="datadog-api-client-v1-model--page-root">datadog_api_client.v1.model<a cl
 <li><p><strong>conditional_formats</strong> (<em>[</em><a class="reference internal" href="#datadog_api_client.v1.model.widget_conditional_format.WidgetConditionalFormat" title="datadog_api_client.v1.model.widget_conditional_format.WidgetConditionalFormat"><em>WidgetConditionalFormat</em></a><em>]</em><em>, </em><em>optional</em>) – List of conditional formats.</p></li>
 <li><p><strong>formula</strong> (<em>str</em>) – String expression built from queries, formulas, and functions.</p></li>
 <li><p><strong>limit</strong> (<a class="reference internal" href="#datadog_api_client.v1.model.widget_formula_limit.WidgetFormulaLimit" title="datadog_api_client.v1.model.widget_formula_limit.WidgetFormulaLimit"><em>WidgetFormulaLimit</em></a><em>, </em><em>optional</em>) – Options for limiting results returned.</p></li>
+<li><p><strong>style</strong> (<a class="reference internal" href="#datadog_api_client.v1.model.widget_formula_style.WidgetFormulaStyle" title="datadog_api_client.v1.model.widget_formula_style.WidgetFormulaStyle"><em>WidgetFormulaStyle</em></a><em>, </em><em>optional</em>) – Styling options for widget formulas.</p></li>
 </ul>
 </dd>
 </dl>
@@ -26425,6 +26438,23 @@ <h1 id="datadog-api-client-v1-model--page-root">datadog_api_client.v1.model<a cl
 </dl>
 </dd></dl>
 </section>
+<section id="module-datadog_api_client.v1.model.widget_formula_style">
+<span id="widget-formula-style"></span><h2 id="module-datadog_api_client.v1.model.widget_formula_style">widget_formula_style<a class="headerlink" href="#module-datadog_api_client.v1.model.widget_formula_style" title="Permalink to this heading">¶</a></h2>
+<dl class="py class">
+<dt class="sig sig-object py" id="datadog_api_client.v1.model.widget_formula_style.WidgetFormulaStyle">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">WidgetFormulaStyle</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#datadog_api_client.v1.model.widget_formula_style.WidgetFormulaStyle" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <a class="reference internal" href="datadog_api_client.html#datadog_api_client.model_utils.ModelNormal" title="datadog_api_client.model_utils.ModelNormal"><code class="xref py py-class docutils literal notranslate"><span class="pre">ModelNormal</span></code></a></p>
+<p>Styling options for widget formulas.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>palette</strong> (<em>str</em><em>, </em><em>optional</em>) – The color palette used to display the formula. A guide to the available color palettes can be found at <a class="reference external" href="https://docs.datadoghq.com/dashboards/guide/widget_colors">https://docs.datadoghq.com/dashboards/guide/widget_colors</a></p></li>
+<li><p><strong>palette_index</strong> (<em>int</em><em>, </em><em>optional</em>) – Index specifying which color to use within the palette.</p></li>
+</ul>
+</dd>
+</dl>
+</dd></dl>
+</section>
 <section id="module-datadog_api_client.v1.model.widget_grouping">
 <span id="widget-grouping"></span><h2 id="module-datadog_api_client.v1.model.widget_grouping">widget_grouping<a class="headerlink" href="#module-datadog_api_client.v1.model.widget_grouping" title="Permalink to this heading">¶</a></h2>
 <dl class="py class">

genindex.html

@@ -6766,6 +6766,13 @@ <h2 id="D">D</h2>
 
       <ul>
         <li><a href="datadog_api_client.v1.model.html#module-datadog_api_client.v1.model.widget_formula_limit">module</a>
+</li>
+      </ul></li>
+      <li>
+    datadog_api_client.v1.model.widget_formula_style
+
+      <ul>
+        <li><a href="datadog_api_client.v1.model.html#module-datadog_api_client.v1.model.widget_formula_style">module</a>
 </li>
       </ul></li>
       <li>
@@ -14844,6 +14851,8 @@ <h2 id="M">M</h2>
         <li><a href="datadog_api_client.v1.model.html#module-datadog_api_client.v1.model.widget_formula">datadog_api_client.v1.model.widget_formula</a>
 </li>
         <li><a href="datadog_api_client.v1.model.html#module-datadog_api_client.v1.model.widget_formula_limit">datadog_api_client.v1.model.widget_formula_limit</a>
+</li>
+        <li><a href="datadog_api_client.v1.model.html#module-datadog_api_client.v1.model.widget_formula_style">datadog_api_client.v1.model.widget_formula_style</a>
 </li>
         <li><a href="datadog_api_client.v1.model.html#module-datadog_api_client.v1.model.widget_grouping">datadog_api_client.v1.model.widget_grouping</a>
 </li>
@@ -18143,15 +18152,17 @@ <h2 id="W">W</h2>
       <li><a href="datadog_api_client.v1.model.html#datadog_api_client.v1.model.widget_formula.WidgetFormula">WidgetFormula (class in datadog_api_client.v1.model.widget_formula)</a>
 </li>
       <li><a href="datadog_api_client.v1.model.html#datadog_api_client.v1.model.widget_formula_limit.WidgetFormulaLimit">WidgetFormulaLimit (class in datadog_api_client.v1.model.widget_formula_limit)</a>
+</li>
+      <li><a href="datadog_api_client.v1.model.html#datadog_api_client.v1.model.widget_formula_style.WidgetFormulaStyle">WidgetFormulaStyle (class in datadog_api_client.v1.model.widget_formula_style)</a>
 </li>
       <li><a href="datadog_api_client.v1.model.html#datadog_api_client.v1.model.widget_grouping.WidgetGrouping">WidgetGrouping (class in datadog_api_client.v1.model.widget_grouping)</a>
 </li>
       <li><a href="datadog_api_client.v1.model.html#datadog_api_client.v1.model.widget_horizontal_align.WidgetHorizontalAlign">WidgetHorizontalAlign (class in datadog_api_client.v1.model.widget_horizontal_align)</a>
-</li>
-      <li><a href="datadog_api_client.v1.model.html#datadog_api_client.v1.model.widget_image_sizing.WidgetImageSizing">WidgetImageSizing (class in datadog_api_client.v1.model.widget_image_sizing)</a>
 </li>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="datadog_api_client.v1.model.html#datadog_api_client.v1.model.widget_image_sizing.WidgetImageSizing">WidgetImageSizing (class in datadog_api_client.v1.model.widget_image_sizing)</a>
+</li>
       <li><a href="datadog_api_client.v1.model.html#datadog_api_client.v1.model.widget_layout.WidgetLayout">WidgetLayout (class in datadog_api_client.v1.model.widget_layout)</a>
 </li>
       <li><a href="datadog_api_client.v1.model.html#datadog_api_client.v1.model.widget_layout_type.WidgetLayoutType">WidgetLayoutType (class in datadog_api_client.v1.model.widget_layout_type)</a>

py-modindex.html

@@ -4555,6 +4555,11 @@ <h1>Python Module Index</h1>
        <td>&#160;&#160;&#160;
        <a href="datadog_api_client.v1.model.html#module-datadog_api_client.v1.model.widget_formula_limit"><code class="xref">datadog_api_client.v1.model.widget_formula_limit</code></a></td><td>
        <em></em></td></tr>
+     <tr class="cg-1">
+       <td></td>
+       <td>&#160;&#160;&#160;
+       <a href="datadog_api_client.v1.model.html#module-datadog_api_client.v1.model.widget_formula_style"><code class="xref">datadog_api_client.v1.model.widget_formula_style</code></a></td><td>
+       <em></em></td></tr>
      <tr class="cg-1">
        <td></td>
        <td>&#160;&#160;&#160;