@luzmo/analytics-components-kit 1.0.8 → 1.0.9-beta.2

package/components/display-settings-period-over-period-Br08rz7r.cjs

@@ -0,0 +1,227 @@
+/*! * A kit of modern Luzmo Web Components for analytics in your web application.
+ * 
+ * Copyright © 2026 Luzmo
+ * All rights reserved.
+ * Luzmo web components (“Luzmo Web Components”)
+ * must be used according to the Luzmo Terms of Service.
+ * This license allows users with a current active Luzmo account
+ * to use the Luzmo Web Components. This license terminates
+ * automatically if a user no longer has an active Luzmo account.
+ * Please view the Luzmo Terms of Service at: https://www.luzmo.com/information-pages/terms-of-use.
+ * 
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ * */
+require("./tokens-BWMfo_w4.cjs");const e=require("./base-BWU343D_.cjs"),t=require("./decorate-DCJt-2rt.cjs"),n=require("./localized-mixin-DiUJOd06.cjs"),r=require("./localize-D3i4Epy_.cjs"),i=require("./decompose-numeric-format-DGJua3rU.cjs"),a=require("./period-over-period-condition.const-C1NZ9Bkp.cjs");let o=require("lit"),s=require("lit/decorators.js"),c=require("@lit/localize");require("@luzmo/lucero/action-button"),require("@luzmo/lucero/action-group"),require("@luzmo/lucero/field-label"),require("@luzmo/lucero/number-field"),require("@luzmo/lucero/picker"),require("@luzmo/lucero/menu"),require("@luzmo/lucero/accordion"),require("@luzmo/lucero/checkbox");var l={none:()=>(0,c.msg)(`None`),past:()=>(0,c.msg)(`Past value`,{desc:`Period option`}),absoluteChange:()=>(0,c.msg)(`Absolute change`,{desc:`Period option`}),percentageChange:()=>(0,c.msg)(`% change`,{desc:`Period option`})},u=[{key:`periods`,i18n:()=>(0,c.msg)(`Periods`,{desc:`Period option`})},{key:`years`,i18n:()=>(0,c.msg)(`Years`,{desc:`Period option`})},{key:`quarters`,i18n:()=>(0,c.msg)(`Quarters`,{desc:`Period option`})},{key:`months`,i18n:()=>(0,c.msg)(`Months`,{desc:`Period option`})},{key:`weeks`,i18n:()=>(0,c.msg)(`Weeks`,{desc:`Period option`})},{key:`days`,i18n:()=>(0,c.msg)(`Days`,{desc:`Period option`})},{key:`hours`,i18n:()=>(0,c.msg)(`Hours`,{desc:`Period option`})},{key:`minutes`,i18n:()=>(0,c.msg)(`Minutes`,{desc:`Period option`})},{key:`seconds`,i18n:()=>(0,c.msg)(`Seconds`,{desc:`Period option`})}],d=function(e){return e.Relative=`relative`,e.UserDefined=`user-defined`,e}({}),f=[{key:`relative`,i18n:()=>(0,c.msg)(`Relative`,{desc:`Range type option`})},{key:`user-defined`,i18n:()=>(0,c.msg)(`User-defined`,{desc:`Range type option`})}],p=`:host{font-family:var(--luzmo-display-settings-period-over-period-font-family,var(--luzmo-font-family));font-size:var(--luzmo-display-settings-period-over-period-font-size,var(--display-settings-period-over-period-font-size));color:var(--luzmo-display-settings-period-over-period-color,var(--luzmo-font-color))}:host .settings-container{flex-direction:column;gap:0;display:flex}:host .settings-container:first-of-type{margin-right:var(--luzmo-spacing-4)}:host .settings-row{justify-content:flex-start;align-items:center;gap:var(--luzmo-display-settings-period-over-period-gap,var(--display-settings-period-over-period-gap));display:flex}:host .wrap{flex-wrap:wrap}:host .setting.period-number-setting{align-items:center;display:flex}:host .dynamic-settings-container{max-width:var(--luzmo-display-setting-period-over-period-dynamic-max-width,var(--display-setting-period-over-period-dynamic-max-width))}:host luzmo-accordion{--luzmo-accordion-item-content-area-top-to-content:0;--luzmo-accordion-item-content-padding-left:var(--luzmo-spacing-1);--luzmo-accordion-item-header-bottom-margin:0;--luzmo-accordion-item-content-area-bottom-to-content:var(--luzmo-spacing-2);--accordion-item-header-font-size:var(--luzmo-display-settings-period-over-period-font-size,var(--display-settings-period-over-period-font-size));--accordion-item-content-font-size:var(--luzmo-display-settings-period-over-period-font-size,var(--display-settings-period-over-period-font-size))}:host .label-container{align-items:center;gap:var(--luzmo-spacing-2);display:flex}:host .academy-link{color:var(--luzmo-link-color);font-size:var(--luzmo-font-size-s);margin-left:var(--luzmo-spacing-2);text-decoration:none}:host .academy-link:hover{color:var(--luzmo-link-color-hover)}:host(:focus){--luzmo-menu-item-label-icon-color-focus:var(--luzmo-menu-item-label-icon-color-focus,var(--luzmo-font-color))}luzmo-menu-item{--luzmo-menu-item-tooltip-font-size:var(--luzmo-display-settings-tooltip-font-size)}luzmo-checkbox{--checkbox-font-size:var(--luzmo-display-settings-period-over-period-font-size,var(--display-settings-period-over-period-font-size))}luzmo-picker{--picker-font-size:var(--luzmo-display-settings-period-over-period-font-size,var(--display-settings-period-over-period-font-size))}luzmo-number-field{--text-field-placeholder-font-size:var(--luzmo-display-settings-period-over-period-font-size,var(--display-settings-period-over-period-font-size));--stepper-button-font-size:var(--luzmo-display-settings-period-over-period-font-size,var(--display-settings-period-over-period-font-size))}:host{--display-settings-period-over-period-gap:var(--luzmo-spacing-3);--display-settings-period-over-period-font-size:var(--luzmo-font-size);--display-setting-period-over-period-dynamic-max-width:22rem}:host([size=xs]){--display-settings-period-over-period-gap:var(--luzmo-spacing-2);--display-settings-period-over-period-font-size:var(--luzmo-font-size-xs);--display-setting-period-over-period-dynamic-max-width:17rem}:host([size=s]){--display-settings-period-over-period-gap:var(--luzmo-spacing-3);--display-settings-period-over-period-font-size:var(--luzmo-font-size-s);--display-setting-period-over-period-dynamic-max-width:19rem}:host([size=l]){--display-settings-period-over-period-gap:var(--luzmo-spacing-4);--display-settings-period-over-period-font-size:var(--luzmo-font-size-l);--display-setting-period-over-period-dynamic-max-width:26rem}:host([size=xl]){--display-settings-period-over-period-gap:var(--luzmo-spacing-5);--display-settings-period-over-period-font-size:var(--luzmo-font-size-xl);--display-setting-period-over-period-dynamic-max-width:30rem}`,m=class extends n.t(e.n(e.i,{validSizes:Object.values(e.t)})){constructor(...e){super(...e),this.slotContent={},this.allowPeriodsWithoutDatetimeColumn=!1,this.hidePastValue=!1,this.linkedDatasetDatetimeColumns=[],this.needsOffsetDatetimeColumn=()=>this.periodOverPeriodUiType===a.t.NoDatetimeColumnButComparisonFilters||this.periodOverPeriodUiType===a.t.NoDatetimeColumnAndNoComparisonFilters}static get styles(){return[(0,o.unsafeCSS)(p)]}willUpdate(e){if(super.willUpdate(e),e.has(`slotContent`)){this._periodComparison=this.slotContent?.periodOverPeriod?.type,this._numberPeriods=this.slotContent?.periodOverPeriod?.quantity;let e=this.slotContent?.periodOverPeriod?.level;this._periodLevel=typeof e==`number`&&e>=0&&e<u.length?u[e].key:this.slotContent?.periodOverPeriod?.level||`periods`,this._incompletePeriods=this.slotContent?.periodOverPeriod?.periodToDate,this._offsetDateColumn=this.slotContent?.periodOverPeriod?.offsetDateColumn,this._minLevel=this.slotContent?.periodOverPeriod?.minLevel??this.slotContent?.periodOverPeriod?.offsetDateColumn?.lowestLevel??this.slotContent?.lowestLevel??(this.slotContent?.subtype===`date`?5:9),this._rangeType=this.slotContent?.periodOverPeriod?.rangeType}this._periodComparison=this._periodComparison??`none`,this._numberPeriods=this._numberPeriods??1,this._periodLevel=this._periodLevel??`periods`,this._incompletePeriods=this._incompletePeriods??!1,this._minLevel=this._minLevel??9,this._rangeType=this._rangeType??d.Relative,this._offsetDateColumn=this._offsetDateColumn||void 0}setPeriodComparison(){let e={...this.slotContent};this.setInitialOffsetDateColumn(e),this._periodComparison=this._periodComparisonElement.value;let t=i.t(this.slotContent?.format),n=[`%`,`y`,`a%`,`ay`].includes(t.typeFormat),r=t.typeFormat.includes(`a`),a=r?`a`:``,o=t.comma===`,`||r?`,`:``,s=t.precision?Number.parseInt(t.precision.replace(`.`,``),10):0,c=[`z`,`az`,`y`,`ay`,`w`,`aw`].includes(t.typeFormat);this._periodComparison===`percentageChange`&&n&&(e.format=`${o}.${s}${a}${c?`z`:`f`}`),this.sendEvent(e)}setNumberOfPeriods(){this._numberPeriods=Number.parseInt(this._numberPeriodsElement.value,10);let e={...this.slotContent};this.sendEvent(e)}setPeriodLevel(){this._periodLevel=this._periodLevelElement.value;let e={...this.slotContent};this.sendEvent(e)}setOffsetDateColumn(){this._offsetDateColumn=this.linkedDatasetDatetimeColumns.find(e=>e.id===this._offsetDateColumnElement.value);let e={...this.slotContent};this.sendEvent(e)}setIncompletePeriods(){this._incompletePeriods=this._incompletePeriodsElement.checked;let e={...this.slotContent};this.sendEvent(e)}setRangeType(e){this._rangeType=e;let t={...this.slotContent};this.setInitialOffsetDateColumn(t),this.sendEvent(t)}sendEvent(e){let t={...e},n=u.findIndex(e=>e.key===this._periodLevel);t.periodOverPeriod={...e.periodOverPeriod,type:this._periodComparison,level:Math.max(n,0),quantity:this._numberPeriods,periodToDate:this._incompletePeriods,minLevel:this._minLevel,rangeType:this._rangeType,offsetDateColumn:this._offsetDateColumn},this._periodComparison===`none`&&delete t.periodOverPeriod,this.dispatchEvent(new CustomEvent(`luzmo-slot-content-changed`,{bubbles:!0,composed:!0,cancelable:!0,detail:{slotContent:t}}))}incompletePeriodsSetting(){return o.html`
+      <div class="settings-row">
+        <div class="setting">
+          <luzmo-checkbox
+            id="incomplete-periods"
+            size=${this.size}
+            emphasized
+            ?checked=${this._incompletePeriods??!1}
+            @change=${this.setIncompletePeriods}
+          >
+            ${(0,c.msg)(`Use period-to-date for incomplete periods`,{desc:`Checkbox label for incomplete periods`})}
+          </luzmo-checkbox>
+        </div>
+      </div>
+    `}relativeOffsetSetting(){let e=this.needsOffsetDatetimeColumn()&&!this.allowPeriodsWithoutDatetimeColumn,t=u.slice(+!!e,(this._minLevel??0)+1).map(e=>o.html`<luzmo-menu-item
+        value=${e.key}
+        tooltip=${e.key===`periods`?(0,c.msg)(`Matches the date range visible in the chart or table`,{desc:`Tooltip for periods`}):``}
+      >
+        ${e.i18n()}
+      </luzmo-menu-item>`);return o.html`
+      <div class="settings-container" role="group" aria-label=${(0,c.msg)(`Relative offset`,{desc:`Label for relative offset`})}>
+        <luzmo-field-label .size=${this.size} for="number-periods">
+          ${(0,c.msg)(`Relative offset`,{desc:`Label for relative offset`})}
+        </luzmo-field-label>
+
+        <div class="settings-row">
+          <div class="setting period-number-setting">
+            <luzmo-number-field
+              id="number-periods"
+              label=${(0,c.msg)(`Number of periods`,{desc:`Label for number of periods field`})}
+              min="1"
+              size=${this.size}
+              max="9999999999"
+              value=${this._numberPeriods??1}
+              @change=${this.setNumberOfPeriods}
+            ></luzmo-number-field>
+          </div>
+
+          <div class="setting">
+            <luzmo-picker
+              id="period-level"
+              size=${this.size}
+              variant="highlight"
+              value=${this._periodLevel??`periods`}
+              @change=${this.setPeriodLevel}
+            >
+              ${t}
+            </luzmo-picker>
+          </div>
+        </div>
+      </div>
+    `}rangeTypeSetting(){let e=f.map(e=>o.html`<luzmo-action-button
+        data-range-type=${e.key}
+        value=${e.key}
+        @click=${this._handleRangeTypeClick}
+      >
+        ${e.i18n()}
+      </luzmo-action-button>`);return o.html`
+      <div class="settings-container">
+        <luzmo-field-label .size=${this.size} for="range-type">
+          ${(0,c.msg)(`Range type`,{desc:`Label for range type`})}
+        </luzmo-field-label>
+
+        <luzmo-action-group
+          size=${this.size}
+          compact
+          ?emphasized=${!0}
+          selected=${JSON.stringify([this._rangeType])}
+          selects="single"
+        >
+          ${e}
+        </luzmo-action-group>
+      </div>
+    `}_handleRangeTypeClick(e){let t=e.currentTarget?.dataset?.rangeType;t&&this.setRangeType(t)}offsetDateColumnSetting(){let e=this.linkedDatasetDatetimeColumns.map(e=>o.html`<luzmo-menu-item value=${e.id}>
+          ${r.t(e.name,this.language)}
+        </luzmo-menu-item>`);return o.html`
+      <div class="settings-container">
+        <luzmo-field-label .size=${this.size} for="offset-date-column">
+          ${(0,c.msg)(`Offset date column`,{desc:`Label for offset date column`})}
+        </luzmo-field-label>
+
+        <div class="setting">
+          <luzmo-picker
+            id="offset-date-column"
+            size=${this.size}
+            variant="highlight"
+            value=${this._offsetDateColumn?.id}
+            @change=${this.setOffsetDateColumn}
+          >
+            ${e}
+          </luzmo-picker>
+        </div>
+      </div>
+    `}comparisonTypeItems(){return Object.keys(l).filter(e=>!(this.hidePastValue&&e===`past`)).map(e=>o.html`<luzmo-menu-item value=${e}>
+          ${l[e]()}
+        </luzmo-menu-item>`)}typeOfComparisonSetting(){let e=this.comparisonTypeItems();return o.html`<div class="settings-container">
+      <luzmo-field-label .size=${this.size} for="period-comparison">
+        ${(0,c.msg)(`Show`)}
+      </luzmo-field-label>
+      <luzmo-picker
+        id="period-comparison"
+        size=${this.size}
+        variant="highlight"
+        value=${this._periodComparison??`none`}
+        @change=${this.setPeriodComparison}
+      >
+        ${e}
+      </luzmo-picker>
+    </div>`}renderPeriodSettings(){return{[a.t.HasDatetimeColumnAndNoComparisonFilters]:()=>o.html`
+            ${this.relativeOffsetSetting()} ${this.incompletePeriodsSetting()}
+          `,[a.t.NoDatetimeColumnAndNoComparisonFilters]:()=>o.html`
+            ${this.relativeOffsetSetting()} ${this.offsetDateColumnSetting()}
+            ${this.incompletePeriodsSetting()}
+          `,[a.t.HasDatetimeColumnAndComparisonFilters]:()=>this._rangeType===d.Relative?o.html`${this.rangeTypeSetting()} ${this.relativeOffsetSetting()}
+          ${this.incompletePeriodsSetting()} `:o.html` ${this.rangeTypeSetting()} `,[a.t.NoDatetimeColumnButComparisonFilters]:()=>this._rangeType===d.Relative?o.html`
+            ${this.rangeTypeSetting()} ${this.relativeOffsetSetting()}
+            ${this.offsetDateColumnSetting()} ${this.incompletePeriodsSetting()}
+          `:o.html` ${this.rangeTypeSetting()} `,[a.t.OldImplementation]:()=>``}[this.periodOverPeriodUiType]?.()??``}renderOldUiPeriodSettings(){let e=u.slice(0,(this._minLevel??0)+1).map(e=>o.html`<luzmo-menu-item
+          value=${e.key}
+          tooltip=${e.key===`periods`?(0,c.msg)(`Matches the date range visible in the chart or table`,{desc:`Tooltip for periods`}):``}
+        >
+          ${e.i18n()}
+        </luzmo-menu-item>`);return o.html` <div class="settings-row">
+        <div class="setting period-number-setting">
+          ${[`percentageChange`,`absoluteChange`].includes(this._periodComparison??``)?o.html`<luzmo-field-label .size=${this.size} for="number-periods" side-aligned="start">
+                ${(0,c.msg)(`From`,{desc:`Label for number of periods`})}
+              </luzmo-field-label>`:``}
+          <luzmo-number-field
+            id="number-periods"
+            label="Number of periods"
+            min="1"
+            size=${this.size}
+            max="9999999999"
+            value=${this._numberPeriods??1}
+            @change=${this.setNumberOfPeriods}
+          ></luzmo-number-field>
+        </div>
+        <div class="setting">
+          <luzmo-picker
+            id="period-level"
+            size=${this.size}
+            variant="highlight"
+            value=${this._periodLevel??`periods`}
+            @change=${this.setPeriodLevel}
+          >
+            ${e}
+          </luzmo-picker>
+        </div>
+        <div>${(0,c.msg)(`ago`,{desc:`Label for period ago`})}</div>
+      </div>
+      <div class="settings-row">
+        <div class="setting">
+          <luzmo-checkbox
+            id="incomplete-periods"
+            size=${this.size}
+            emphasized
+            ?checked=${this._incompletePeriods??!1}
+            @change=${this.setIncompletePeriods}
+          >
+            ${(0,c.msg)(`Use period-to-date for incomplete periods`,{desc:`Checkbox label for incomplete periods`})}
+          </luzmo-checkbox>
+        </div>
+      </div>`}renderOldUi(){let e=this.comparisonTypeItems();return o.html`<div class="settings-container">
+      <div class="settings-row">
+        <div class="setting">
+          <div class="label-container">
+            <luzmo-field-label .size=${this.size} for="period-comparison">
+              ${(0,c.msg)(`Period comparison`,{desc:`Label for period comparison`})}
+            </luzmo-field-label>
+
+            <a
+              target="_blank"
+              rel="noopener noreferrer"
+              href="https://academy.luzmo.com/article/yh728g3n"
+              class="academy-link"
+              aria-label=${(0,c.msg)(`Learn more (opens in new tab)`,{desc:`Aria label for academy link that opens in new tab`})}
+            >
+              ${(0,c.msg)(`Learn more`,{desc:`Label for academy link`})}
+            </a>
+          </div>
+
+          <luzmo-picker
+            id="period-comparison"
+            size=${this.size}
+            variant="highlight"
+            value=${this._periodComparison??`none`}
+            @change=${this.setPeriodComparison}
+          >
+            ${e}
+          </luzmo-picker>
+        </div>
+      </div>
+      ${this._periodComparison===`none`?``:this.renderOldUiPeriodSettings()}
+    </div>`}render(){return this.periodOverPeriodUiType===a.t.OldImplementation?this.renderOldUi():o.html`
+      <luzmo-accordion variant="highlight-child" class="setting">
+        <luzmo-accordion-item
+          ?open=${this._periodComparison!==`none`}
+          label=${(0,c.msg)(`Period comparison`,{desc:`Label for period comparison`})}
+        >
+          <div class="settings-container dynamic-settings-container">
+            <div class="settings-row wrap">
+              ${this.typeOfComparisonSetting()}
+              ${this._periodComparison===`none`?``:this.renderPeriodSettings()}
+            </div>
+          </div>
+        </luzmo-accordion-item>
+      </luzmo-accordion>
+    `}setInitialOffsetDateColumn(e){this._offsetDateColumn=this.needsOffsetDatetimeColumn()?this.linkedDatasetDatetimeColumns[0]:void 0,e.periodOverPeriod.offsetDateColumn=this._offsetDateColumn}};t.t([(0,s.property)({type:Object,attribute:`slot-content`})],m.prototype,`slotContent`,void 0),t.t([(0,s.property)({type:String,attribute:`period-over-period-type`})],m.prototype,`periodOverPeriodUiType`,void 0),t.t([(0,s.property)({type:Boolean,attribute:`allow-periods-without-datetime-column`,reflect:!0})],m.prototype,`allowPeriodsWithoutDatetimeColumn`,void 0),t.t([(0,s.property)({type:Boolean,attribute:`hide-past-value`,reflect:!0})],m.prototype,`hidePastValue`,void 0),t.t([(0,s.property)({type:Array,attribute:`linked-dataset-datetime-columns`})],m.prototype,`linkedDatasetDatetimeColumns`,void 0),t.t([(0,s.query)(`#period-comparison`)],m.prototype,`_periodComparisonElement`,void 0),t.t([(0,s.query)(`#number-periods`)],m.prototype,`_numberPeriodsElement`,void 0),t.t([(0,s.query)(`#period-level`)],m.prototype,`_periodLevelElement`,void 0),t.t([(0,s.query)(`#offset-date-column`)],m.prototype,`_offsetDateColumnElement`,void 0),t.t([(0,s.query)(`#incomplete-periods`)],m.prototype,`_incompletePeriodsElement`,void 0),t.t([(0,s.state)()],m.prototype,`_periodComparison`,void 0),t.t([(0,s.state)()],m.prototype,`_rangeType`,void 0),m=t.t([(0,c.localized)()],m),customElements.get(`luzmo-display-settings-period-over-period`)||customElements.define(`luzmo-display-settings-period-over-period`,m),Object.defineProperty(exports,"t",{enumerable:!0,get:function(){return m}});