@firestitch/report 18.18.2 → 18.19.0

package/app/reports/chart-axis-settings.d.ts

@@ -0,0 +1,4 @@
+import { ReportChartAxisSettings } from './interfaces/report-chart-axis-settings.interface';
+import { ChartConfig } from './interfaces/report.interface';
+export declare function chartAxisSettings(config: ChartConfig | null | undefined): ReportChartAxisSettings;
+export declare function sameChartAxisSettings(a: ReportChartAxisSettings, b: ReportChartAxisSettings): boolean;

package/app/reports/components/report-component/report-component.component.d.ts

@@ -87,6 +87,7 @@ export declare class ReportComponentComponent implements OnInit, OnChanges {
     applySettings(settings: ComponentSettings): void;
     exportCsv(): void;
     exportExcel(): void;
+    private _axisWith;
     private _export;
     onMarkClick(click: ReportMarkClick): void;
     onMarkMiss(): void;

package/app/reports/dialogs/component-settings/component-settings.component.d.ts

@@ -2,6 +2,8 @@ import { EventEmitter, OnInit } from '@angular/core';
 import { AbstractControl } from '@angular/forms';
 import { Observable } from 'rxjs';
 import { ReportChangePolarity } from '../../enums/report-change-polarity.enum';
+import { ReportChartDateLabel } from '../../enums/report-chart-date-label.enum';
+import { ReportChartSpanMode } from '../../enums/report-chart-span-mode.enum';
 import { ChartGranularity, ComponentSettings, Report, ReportComponent, ReportFilterType } from '../../interfaces/report.interface';
 import { FilterBarPlacement } from '../../interfaces/filter-bar-placement.type';
 import { FilterComponentToggleState } from '../../interfaces/filter-component-toggle-state.interface';
@@ -68,6 +70,23 @@ export declare class ComponentSettingsComponent implements OnInit {
     readonly sparkline: import("@angular/core").WritableSignal<boolean>;
     readonly sparklineGranularity: import("@angular/core").WritableSignal<ChartGranularity>;
     readonly sparklinePeriods: import("@angular/core").WritableSignal<string | number>;
+    readonly dateLabelOptions: {
+        value: ReportChartDateLabel;
+        name: string;
+    }[];
+    readonly spanModeOptions: {
+        value: ReportChartSpanMode;
+        name: string;
+    }[];
+    readonly spanMinPeriods = 1;
+    readonly spanMaxPeriods = 400;
+    readonly ReportChartSpanMode: typeof ReportChartSpanMode;
+    readonly timeAxis: import("@angular/core").WritableSignal<boolean>;
+    readonly spanAllowed: import("@angular/core").WritableSignal<boolean>;
+    readonly dateLabel: import("@angular/core").WritableSignal<ReportChartDateLabel>;
+    readonly spanMode: import("@angular/core").WritableSignal<ReportChartSpanMode>;
+    readonly spanPeriods: import("@angular/core").WritableSignal<string | number>;
+    readonly spanStart: import("@angular/core").WritableSignal<Date>;
     readonly sql: import("@angular/core").WritableSignal<string>;
     readonly sqlBaseline: import("@angular/core").WritableSignal<boolean>;
     readonly sqlTimezone: import("@angular/core").WritableSignal<string>;
@@ -106,6 +125,11 @@ export declare class ComponentSettingsComponent implements OnInit {
     private _layerValues;
     private _valueName;
     private _seedKpiCard;
+    private _seedTimeAxis;
+    private _chartAxisSettings;
+    private _span;
+    private _sentAxisKeys;
+    private _savedChartAxis;
     private _savedKpiCard;
     private _kpiCardSettings;
     private _targetShown;

package/app/reports/enums/report-chart-date-label.enum.d.ts

@@ -1,5 +1,6 @@
 export declare enum ReportChartDateLabel {
     Short = "short",
     Long = "long",
-    Numeric = "numeric"
+    Numeric = "numeric",
+    PeriodEnd = "periodEnd"
 }

package/app/reports/enums/report-chart-span-mode.enum.d.ts

@@ -0,0 +1,5 @@
+export declare enum ReportChartSpanMode {
+    None = "none",
+    Periods = "periods",
+    Start = "start"
+}

package/app/reports/enums/report-chart-span-through.enum.d.ts

@@ -0,0 +1,3 @@
+export declare enum ReportChartSpanThrough {
+    FilterEnd = "filterEnd"
+}

package/app/reports/format.d.ts

@@ -50,6 +50,7 @@ export declare const DAY_LONG: Intl.DateTimeFormatOptions;
 export declare const MONTH_LONG: Intl.DateTimeFormatOptions;
 export declare const MONTH_YEAR: Intl.DateTimeFormatOptions;
 export declare const MONTH_DAY: Intl.DateTimeFormatOptions;
+export declare const DAY_NUMERIC: Intl.DateTimeFormatOptions;
 export declare function formatLocalDate(date: Date, locale: ReportLocaleTag, options: Intl.DateTimeFormatOptions, timeZone?: string): string;
 export declare function formatReportDate(value: unknown, timezone: string, locale: ReportLocaleTag): string;
 export declare const TIME_SHORT: Intl.DateTimeFormatOptions;

package/app/reports/interfaces/report-chart-axis-settings.interface.d.ts

@@ -0,0 +1,6 @@
+import { ReportChartDateLabel } from '../enums/report-chart-date-label.enum';
+import { ReportChartSpan } from './report-chart-span.interface';
+export interface ReportChartAxisSettings {
+    dateLabel: ReportChartDateLabel | null;
+    span: ReportChartSpan | null;
+}

package/app/reports/interfaces/report-chart-span.interface.d.ts

@@ -0,0 +1,6 @@
+import { ReportChartSpanThrough } from '../enums/report-chart-span-through.enum';
+export interface ReportChartSpan {
+    through: ReportChartSpanThrough;
+    periods?: number;
+    start?: string;
+}

package/app/reports/interfaces/report.interface.d.ts

@@ -11,6 +11,8 @@ import { ReportValueFormat } from '../enums/report-value-format.enum';
 import { ReportValueFormula } from '../enums/report-value-formula.enum';
 import { ComponentDataApplied } from './component-data-applied.interface';
 import { ComponentDataDrill } from './component-data-drill.interface';
+import { ReportChartAxisSettings } from './report-chart-axis-settings.interface';
+import { ReportChartSpan } from './report-chart-span.interface';
 import { ReportDrillStep } from './report-drill-step.interface';
 import { GridConfig } from './report-grid-config.interface';
 import { ReportViewerFeature } from './report-viewer-feature.type';
@@ -140,6 +142,7 @@ export interface ComponentSettings {
     title: string;
     padding: ComponentPadding;
     kpi?: KpiCardSettings;
+    chartAxis?: ReportChartAxisSettings;
 }
 export interface KpiCardSettings {
     increaseIs: ReportChangePolarity | null;
@@ -162,10 +165,12 @@ export interface ChartConfig {
         granularity?: ChartGranularity;
         label?: string;
         dateLabel?: ReportChartDateLabel;
+        span?: ReportChartSpan;
     };
     measures?: ChartMeasure[];
     splitBy?: {
         column: string;
+        label?: string;
     };
     colorBy?: {
         column: string;

package/esm2022/app/reports/chart-axis-settings.mjs

@@ -0,0 +1,24 @@
+import { ReportChartDateLabel } from './enums/report-chart-date-label.enum';
+// A time-axis chart's settings-dialog keys (dateLabel and span), from its
+// config.xAxis; null where the config has none.
+export function chartAxisSettings(config) {
+    return {
+        dateLabel: config?.xAxis?.dateLabel ?? null,
+        span: config?.xAxis?.span ?? null,
+    };
+}
+// Whether two sets of time-axis keys draw the same chart. Short and an absent
+// dateLabel are one, as are a span's absent and null periods or start.
+export function sameChartAxisSettings(a, b) {
+    return JSON.stringify(normalizedAxisSettings(a)) === JSON.stringify(normalizedAxisSettings(b));
+}
+function normalizedAxisSettings(settings) {
+    const { dateLabel, span } = settings;
+    return {
+        dateLabel: dateLabel === ReportChartDateLabel.Short ? null : (dateLabel ?? null),
+        span: span
+            ? { through: span.through, periods: span.periods ?? undefined, start: span.start || undefined }
+            : null,
+    };
+}
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY2hhcnQtYXhpcy1zZXR0aW5ncy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uLy4uL3NyYy9hcHAvcmVwb3J0cy9jaGFydC1heGlzLXNldHRpbmdzLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLE9BQU8sRUFBRSxvQkFBb0IsRUFBRSxNQUFNLHNDQUFzQyxDQUFDO0FBSzVFLDBFQUEwRTtBQUMxRSxnREFBZ0Q7QUFDaEQsTUFBTSxVQUFVLGlCQUFpQixDQUFDLE1BQXNDO0lBQ3RFLE9BQU87UUFDTCxTQUFTLEVBQUUsTUFBTSxFQUFFLEtBQUssRUFBRSxTQUFTLElBQUksSUFBSTtRQUMzQyxJQUFJLEVBQUUsTUFBTSxFQUFFLEtBQUssRUFBRSxJQUFJLElBQUksSUFBSTtLQUNsQyxDQUFDO0FBQ0osQ0FBQztBQUVELDhFQUE4RTtBQUM5RSx1RUFBdUU7QUFDdkUsTUFBTSxVQUFVLHFCQUFxQixDQUFDLENBQTBCLEVBQUUsQ0FBMEI7SUFDMUYsT0FBTyxJQUFJLENBQUMsU0FBUyxDQUFDLHNCQUFzQixDQUFDLENBQUMsQ0FBQyxDQUFDLEtBQUssSUFBSSxDQUFDLFNBQVMsQ0FBQyxzQkFBc0IsQ0FBQyxDQUFDLENBQUMsQ0FBQyxDQUFDO0FBQ2pHLENBQUM7QUFFRCxTQUFTLHNCQUFzQixDQUFDLFFBQWlDO0lBQy9ELE1BQU0sRUFBRSxTQUFTLEVBQUUsSUFBSSxFQUFFLEdBQUcsUUFBUSxDQUFDO0lBRXJDLE9BQU87UUFDTCxTQUFTLEVBQUUsU0FBUyxLQUFLLG9CQUFvQixDQUFDLEtBQUssQ0FBQyxDQUFDLENBQUMsSUFBSSxDQUFDLENBQUMsQ0FBQyxDQUFDLFNBQVMsSUFBSSxJQUFJLENBQUM7UUFDaEYsSUFBSSxFQUFFLElBQUk7WUFDUixDQUFDLENBQUMsRUFBRSxPQUFPLEVBQUUsSUFBSSxDQUFDLE9BQU8sRUFBRSxPQUFPLEVBQUUsSUFBSSxDQUFDLE9BQU8sSUFBSSxTQUFTLEVBQUUsS0FBSyxFQUFFLElBQUksQ0FBQyxLQUFLLElBQUksU0FBUyxFQUFFO1lBQy9GLENBQUMsQ0FBQyxJQUFJO0tBQ1QsQ0FBQztBQUNKLENBQUMiLCJzb3VyY2VzQ29udGVudCI6WyJpbXBvcnQgeyBSZXBvcnRDaGFydERhdGVMYWJlbCB9IGZyb20gJy4vZW51bXMvcmVwb3J0LWNoYXJ0LWRhdGUtbGFiZWwuZW51bSc7XG5pbXBvcnQgeyBSZXBvcnRDaGFydEF4aXNTZXR0aW5ncyB9IGZyb20gJy4vaW50ZXJmYWNlcy9yZXBvcnQtY2hhcnQtYXhpcy1zZXR0aW5ncy5pbnRlcmZhY2UnO1xuaW1wb3J0IHsgQ2hhcnRDb25maWcgfSBmcm9tICcuL2ludGVyZmFjZXMvcmVwb3J0LmludGVyZmFjZSc7XG5cblxuLy8gQSB0aW1lLWF4aXMgY2hhcnQncyBzZXR0aW5ncy1kaWFsb2cga2V5cyAoZGF0ZUxhYmVsIGFuZCBzcGFuKSwgZnJvbSBpdHNcbi8vIGNvbmZpZy54QXhpczsgbnVsbCB3aGVyZSB0aGUgY29uZmlnIGhhcyBub25lLlxuZXhwb3J0IGZ1bmN0aW9uIGNoYXJ0QXhpc1NldHRpbmdzKGNvbmZpZzogQ2hhcnRDb25maWcgfCBudWxsIHwgdW5kZWZpbmVkKTogUmVwb3J0Q2hhcnRBeGlzU2V0dGluZ3Mge1xuICByZXR1cm4ge1xuICAgIGRhdGVMYWJlbDogY29uZmlnPy54QXhpcz8uZGF0ZUxhYmVsID8/IG51bGwsXG4gICAgc3BhbjogY29uZmlnPy54QXhpcz8uc3BhbiA/PyBudWxsLFxuICB9O1xufVxuXG4vLyBXaGV0aGVyIHR3byBzZXRzIG9mIHRpbWUtYXhpcyBrZXlzIGRyYXcgdGhlIHNhbWUgY2hhcnQuIFNob3J0IGFuZCBhbiBhYnNlbnRcbi8vIGRhdGVMYWJlbCBhcmUgb25lLCBhcyBhcmUgYSBzcGFuJ3MgYWJzZW50IGFuZCBudWxsIHBlcmlvZHMgb3Igc3RhcnQuXG5leHBvcnQgZnVuY3Rpb24gc2FtZUNoYXJ0QXhpc1NldHRpbmdzKGE6IFJlcG9ydENoYXJ0QXhpc1NldHRpbmdzLCBiOiBSZXBvcnRDaGFydEF4aXNTZXR0aW5ncyk6IGJvb2xlYW4ge1xuICByZXR1cm4gSlNPTi5zdHJpbmdpZnkobm9ybWFsaXplZEF4aXNTZXR0aW5ncyhhKSkgPT09IEpTT04uc3RyaW5naWZ5KG5vcm1hbGl6ZWRBeGlzU2V0dGluZ3MoYikpO1xufVxuXG5mdW5jdGlvbiBub3JtYWxpemVkQXhpc1NldHRpbmdzKHNldHRpbmdzOiBSZXBvcnRDaGFydEF4aXNTZXR0aW5ncyk6IFJlcG9ydENoYXJ0QXhpc1NldHRpbmdzIHtcbiAgY29uc3QgeyBkYXRlTGFiZWwsIHNwYW4gfSA9IHNldHRpbmdzO1xuXG4gIHJldHVybiB7XG4gICAgZGF0ZUxhYmVsOiBkYXRlTGFiZWwgPT09IFJlcG9ydENoYXJ0RGF0ZUxhYmVsLlNob3J0ID8gbnVsbCA6IChkYXRlTGFiZWwgPz8gbnVsbCksXG4gICAgc3Bhbjogc3BhblxuICAgICAgPyB7IHRocm91Z2g6IHNwYW4udGhyb3VnaCwgcGVyaW9kczogc3Bhbi5wZXJpb2RzID8/IHVuZGVmaW5lZCwgc3RhcnQ6IHNwYW4uc3RhcnQgfHwgdW5kZWZpbmVkIH1cbiAgICAgIDogbnVsbCxcbiAgfTtcbn1cbiJdfQ==