---
schema_version: "1"
id: 7e117dd9c6f08c698d8ef05a4635f247c4d53e7507ab0f88f45cd24037dccf5d
title: PromotionHoverContent Class
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/retail_api/promotion_content_hover_class.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/promotion_content_hover_class.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: 2dea2a4ebded5d0499382df6d4c5ba0001fd6c4cb9b02bf095b2176b7b93bf61
description: The PromotionHoverContent Apex class provides programmatic access to the promotion hover content and the buttons on the trade calendar promotion launchpad UI.
---
# PromotionHoverContent Class

The PromotionHoverContent Apex class provides programmatic access to the promotion hover content and the buttons on the trade calendar promotion launchpad UI.

## Namespace

cgcloud

## Example Implementation

cgcloud.PromotionHoverContent promoHoverContent;

## Supported Methods

<table class="featureTable sort_table" summary="">
          <caption><span class="tablecap">Table 1. PromotionHoverContent Methods</span></caption>



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d51650e80">Method Signature</th>

              <th class="featureTableHeader  " id="d51650e83">Description</th>

              <th class="featureTableHeader  " id="d51650e86">Version</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d51650e80" data-title="Method Signature"><samp class="codeph nolang">cgcloud.PromotionHoverContent.Attribute(String
                  label, String value)</samp></td>

              <td class="entry" headers="d51650e83" data-title="Description">Constructor for loading a <samp class="codeph nolang">PromotionHoverContent</samp> attribute.</td>

              <td class="entry" headers="d51650e86" data-title="Version">60.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d51650e80" data-title="Method Signature"><samp class="codeph nolang">cgcloud.PromotionHoverContent.KPI(String readCode,
                  Srting label)</samp></td>

              <td class="entry" headers="d51650e83" data-title="Description">Constructor for loading a KPI. The constructor parameters are:<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">readCode</samp>: String. The read code for the
                    KPI to display.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">label</samp>: String. The label displayed on the
                    UI.
                  </li>

                </ul>
              </td>

              <td class="entry" headers="d51650e86" data-title="Version">60.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d51650e80" data-title="Method Signature"><samp class="codeph nolang">cgcloud.PromotionHoverContent.ThresholdKPI(String
                  readCode, String label, Decimal redThreshold, Decimal
                  greenThreshold)</samp></td>

              <td class="entry" headers="d51650e83" data-title="Description">Constructor for loading a threshold KPI. A threshold KPI extends the KPI class.
                The constructor parameters are:<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">readCode</samp>: String. The read code for the
                    KPI to display.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">label</samp>: String. The label displayed on the
                    UI.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">redThreshold</samp>: Decimal. The red threshold
                    the KPI value is compared against.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">greenThreshold</samp>: Decimal. The green
                    threshold the KPI value is compared against.
                  </li>

                </ul>
                <p class="p">A red, green, or yellow colored dot is displayed next to a KPI value on the
                  UI based on how close or far the KPI value is from the thresholds.</p>
              </td>

              <td class="entry" headers="d51650e86" data-title="Version">60.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d51650e80" data-title="Method Signature"><samp class="codeph nolang">getAttributes()</samp></td>

              <td class="entry" headers="d51650e83" data-title="Description">Returns the default attributes configured for the <samp class="codeph nolang">PromotionHoverContent</samp> instance.</td>

              <td class="entry" headers="d51650e86" data-title="Version">60.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d51650e80" data-title="Method Signature"><samp class="codeph nolang">getCopyButtonVisible()</samp></td>

              <td class="entry" headers="d51650e83" data-title="Description">Returns whether the Copy button is visible (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>).</td>

              <td class="entry" headers="d51650e86" data-title="Version">60.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d51650e80" data-title="Method Signature"><samp class="codeph nolang">getDeleteButtonVisible()</samp></td>

              <td class="entry" headers="d51650e83" data-title="Description">Returns whether the Delete button is visible (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>).</td>

              <td class="entry" headers="d51650e86" data-title="Version">60.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d51650e80" data-title="Method Signature"><samp class="codeph nolang">getDeriveButtonVisible()</samp></td>

              <td class="entry" headers="d51650e83" data-title="Description">Returns whether the Derive button is visible (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>).</td>

              <td class="entry" headers="d51650e86" data-title="Version">60.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d51650e80" data-title="Method Signature"><samp class="codeph nolang">getEditButtonVisible()&nbsp;</samp></td>

              <td class="entry" headers="d51650e83" data-title="Description">Returns whether the Edit button is visible (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>).</td>

              <td class="entry" headers="d51650e86" data-title="Version">60.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d51650e80" data-title="Method Signature"><samp class="codeph nolang">getHeaderRow1()</samp></td>

              <td class="entry" headers="d51650e83" data-title="Description">Gets the values of the first header row displayed on the promotion
                launchpad.</td>

              <td class="entry" headers="d51650e86" data-title="Version">60.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d51650e80" data-title="Method Signature"><samp class="codeph nolang">getHeaderRow2()</samp></td>

              <td class="entry" headers="d51650e83" data-title="Description">Gets the values of the second header row displayed on the promotion
                launchpad.</td>

              <td class="entry" headers="d51650e86" data-title="Version">60.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d51650e80" data-title="Method Signature"><samp class="codeph nolang">getHeaderRow3()</samp></td>

              <td class="entry" headers="d51650e83" data-title="Description">Gets the values of the third header row displayed on the promotion
                launchpad.</td>

              <td class="entry" headers="d51650e86" data-title="Version">60.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d51650e80" data-title="Method Signature"><samp class="codeph nolang">getKPIs()</samp></td>

              <td class="entry" headers="d51650e83" data-title="Description">Returns the configured KPIs with the read codes for the given <samp class="codeph nolang">PromotionHoverContent</samp> instance. Possible read codes are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">LROI</samp></li>

                  <li class="li"><samp class="codeph nolang">LETV</samp></li>

                  <li class="li"><samp class="codeph nolang">LETM</samp></li>

                  <li class="li"><samp class="codeph nolang">LETP</samp></li>

                </ul>
              </td>

              <td class="entry" headers="d51650e86" data-title="Version">60.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d51650e80" data-title="Method Signature"><samp class="codeph nolang">getOpenInNewTabButtonVisible()</samp></td>

              <td class="entry" headers="d51650e83" data-title="Description">Indicates whether the Open In button is visible (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>).</td>

              <td class="entry" headers="d51650e86" data-title="Version">60.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d51650e80" data-title="Method Signature"><samp class="codeph nolang">setAttributes(List&lt;cgcloud.PromotionHoverContent.Attribute&gt;
                  attributes)</samp></td>

              <td class="entry" headers="d51650e83" data-title="Description">Sets new attributes on the promotion launchpad.</td>

              <td class="entry" headers="d51650e86" data-title="Version">60.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d51650e80" data-title="Method Signature"><samp class="codeph nolang">setCopyButtonVisible(Boolean
                  value)</samp></td>

              <td class="entry" headers="d51650e83" data-title="Description">Sets the visibility of the Copy button to true or false.</td>

              <td class="entry" headers="d51650e86" data-title="Version">60.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d51650e80" data-title="Method Signature"><samp class="codeph nolang">setDeleteButtonVisible(Boolean
                  value)</samp></td>

              <td class="entry" headers="d51650e83" data-title="Description">Sets the visibility of the Delete button to true or false.</td>

              <td class="entry" headers="d51650e86" data-title="Version">60.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d51650e80" data-title="Method Signature"><samp class="codeph nolang">setDeriveButtonVisible(Boolean
                  value)</samp></td>

              <td class="entry" headers="d51650e83" data-title="Description">Sets the visibility of the Derive button to true or false.</td>

              <td class="entry" headers="d51650e86" data-title="Version">60.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d51650e80" data-title="Method Signature"><samp class="codeph nolang">setEditButtonVisible(Boolean
                  value)</samp></td>

              <td class="entry" headers="d51650e83" data-title="Description">Sets the visibility of the Edit button to true or false.</td>

              <td class="entry" headers="d51650e86" data-title="Version">60.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d51650e80" data-title="Method Signature"><samp class="codeph nolang">setHeaderRow1(String value)</samp></td>

              <td class="entry" headers="d51650e83" data-title="Description">Sets a new value for the first header row displayed on the promotion
                launchpad.</td>

              <td class="entry" headers="d51650e86" data-title="Version">60.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d51650e80" data-title="Method Signature"><samp class="codeph nolang">setHeaderRow2(String value)</samp></td>

              <td class="entry" headers="d51650e83" data-title="Description">Sets a new value for the second header row displayed on the promotion
                launchpad.</td>

              <td class="entry" headers="d51650e86" data-title="Version">60.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d51650e80" data-title="Method Signature"><samp class="codeph nolang">setHeaderRow3(String value)</samp></td>

              <td class="entry" headers="d51650e83" data-title="Description">Sets a new value for the third header row displayed on the promotion
                launchpad.</td>

              <td class="entry" headers="d51650e86" data-title="Version">60.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d51650e80" data-title="Method Signature"><samp class="codeph nolang">setKPIs( List&lt;cgcloud.PromotionHoverContent.KPI&gt;
                  kpis)</samp></td>

              <td class="entry" headers="d51650e83" data-title="Description">Sets new KPIs on the promotion launchpad.</td>

              <td class="entry" headers="d51650e86" data-title="Version">60.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d51650e80" data-title="Method Signature"><samp class="codeph nolang">setOpenInNewTabButtonVisible(Boolean
                  value)</samp></td>

              <td class="entry" headers="d51650e83" data-title="Description">Sets the visibility of the Open In button to true or false.</td>

              <td class="entry" headers="d51650e86" data-title="Version">60.0</td>

            </tr>

          </tbody>

        </table>