igniteui-angular-sovn/src/lib/grids/pivot-grid/pivot-grid-dimensions.ts

Ignite UI for Angular is a dependency-free Angular toolkit for building modern web apps

import { IGridResourceStrings } from '../../core/i18n/grid-resources';
import { CurrentResourceStrings } from '../../core/i18n/resources';
import { GridColumnDataType } from '../../data-operations/data-util';
import { IPivotDimension } from './pivot-grid.interface';
import { PivotUtil } from './pivot-util';

export interface IPivotDateDimensionOptions {
    /** Enables/Disables total value of all periods. */
    total?: boolean;
    /** Enables/Disables dimensions per year from provided periods. */
    years?: boolean;
    /*/** Enables/Disables dimensions per quarter from provided periods. */
    quarters?: boolean;
    /** Enables/Disables dimensions per month from provided periods. */
    months?: boolean;
    /** Enabled/Disables dimensions for the full date provided */
    fullDate?: boolean;
}

// Equals to pretty much this configuration:
// {
//     member: () => 'All Periods',
//     enabled: true,
//     fieldName: 'AllPeriods',
//     childLevel: {
//         fieldName: 'Years',
//         member: (rec) => {
//             const recordValue = rec['Date'];
//             return recordValue ? (new Date(recordValue)).getFullYear().toString() : rec['Years'];
//         },
//         enabled: true,
//         childLevel: {
//                 member: (rec) => {
//                     const recordValue = rec['Date'];
//                     return recordValue ? new Date(recordValue).toLocaleString('default', { month: 'long' }) : rec['Months'];
//                 },
//                 enabled: true,
//                 fieldName: 'Months',
//                 childLevel: {
//                         member: 'Date',
//                         fieldName:'Date',
//                         enabled: true
//                     }
//             }
//     }
// },
export class IgxPivotDateDimension implements IPivotDimension {
    /** Enables/Disables a particular dimension from pivot structure. */
    public enabled = true;

    /**
     * Gets/Sets data type
     */
    public dataType?: GridColumnDataType;

    /** Default options. */
    public defaultOptions = {
        total: true,
        years: true,
        months: true,
        fullDate: true
    };

    /**
     * Gets/Sets the resource strings.
     *
     * @remarks
     * By default it uses EN resources.
     */
    public set resourceStrings(value: IGridResourceStrings) {
        this._resourceStrings = Object.assign({}, this._resourceStrings, value);
    }

    public get resourceStrings(): IGridResourceStrings {
        return this._resourceStrings;
    }

    /**
     * Gets/Sets the base dimension that is used by this class to determine the other dimensions and their values.
     * Having base dimension set is required in order for the Date Dimensions to show.
     */
    public get baseDimension(): IPivotDimension {
        return this._baseDimension;
    }
    public set baseDimension(value: IPivotDimension) {
        this._baseDimension = value;
        this.initialize(this.baseDimension, this.options);
    }

    /**
     * Gets/Sets the options for the predefined date dimensions whether to show quarter, years and etc.
     */
    public get options(): IPivotDateDimensionOptions {
        return this._options;
    }
    public set options(value: IPivotDateDimensionOptions) {
        this._options = value;
        if (this.baseDimension) {
            this.initialize(this.baseDimension, this.options);
        }
    }

    /**
     * @deprecated since version 15.1.x. Please use the new name `baseDimension` for future versions.
     *
     * Gets the base dimension that is used by this class to determine the other dimensions and their values.
     * Having base dimension set is required in order for the Date Dimensions to show.
     */
    public get inBaseDimension(): IPivotDimension {
        return this._baseDimension;
    }

    /**
     * @deprecated since version 15.1.x. Please use the new name `options` for future versions.
     *
     * Gets the options for the predefined date dimensions whether to show quarter, years and etc.
     */
    public get inOptions(): IPivotDateDimensionOptions {
        return this._options;
    }

    /** @hidden @internal */
    public childLevel?: IPivotDimension;
    /** @hidden @internal */
    public memberName = 'AllPeriods';
    private _resourceStrings = CurrentResourceStrings.GridResStrings;
    private _baseDimension: IPivotDimension;
    private _options: IPivotDateDimensionOptions = {};
    private _monthIntl = new Intl.DateTimeFormat('default', { month: 'long' });

    /**
     * Creates additional pivot date dimensions based on a provided dimension describing date data:
     *
     * @param inDateDimension Base dimension that is used by this class to determine the other dimensions and their values.
     * @param inOptions Options for the predefined date dimensions whether to show quarter, years and etc.
     * @example
     * ```typescript
     * // Displays only years as parent dimension to the base dimension provided.
     * new IgxPivotDateDimension({ memberName: 'Date', enabled: true }, { total: false, months: false });
     * ```
     */
    constructor(inBaseDimension: IPivotDimension, inOptions: IPivotDateDimensionOptions = {}) {
        this._baseDimension = inBaseDimension;
        this._options = inOptions;
        if (this.baseDimension && this.options) {
            this.initialize(this.baseDimension, this.options);
        }
    }

    protected initialize(inBaseDimension, inOptions) {
        const options = { ...this.defaultOptions, ...inOptions };

        this.dataType = GridColumnDataType.Date;
        inBaseDimension.dataType = GridColumnDataType.Date;

        const baseDimension = options.fullDate ? inBaseDimension : null;
        const monthDimensionDef: IPivotDimension = {
            memberName: 'Months',
            memberFunction: (rec) => {
                const recordValue = PivotUtil.extractValueFromDimension(inBaseDimension, rec);
                return recordValue ? this._monthIntl.format(new Date(recordValue)) : rec['Months'];
            },
            enabled: true,
            childLevel: baseDimension
        };
        const monthDimension = options.months ? monthDimensionDef : baseDimension;

        const quarterDimensionDef: IPivotDimension = {
            memberName: 'Quarters',
            memberFunction: (rec) => {
                const recordValue = PivotUtil.extractValueFromDimension(inBaseDimension, rec);
                return recordValue ? `Q` + Math.ceil((new Date(recordValue).getMonth() + 1) / 3) : rec['Quarters'];
            },
            enabled: true,
            childLevel: monthDimension
        };
        const quarterDimension = options.quarters ? quarterDimensionDef : monthDimension;

        const yearsDimensionDef: IPivotDimension = {
            memberName: 'Years',
            memberFunction: (rec) => {
                const recordValue = PivotUtil.extractValueFromDimension(inBaseDimension, rec);
                return recordValue ? (new Date(recordValue)).getFullYear().toString() : rec['Years'];
            },
            enabled: true,
            childLevel: quarterDimension
        };
        const yearsDimension = options.years ? yearsDimensionDef : quarterDimension;
        this.childLevel = yearsDimension;

        if (!options.total) {
            this.memberName = yearsDimension.memberName;
            this.memberFunction = yearsDimension.memberFunction;
            this.childLevel = yearsDimension.childLevel;
        }
    }

    /** @hidden @internal */
    public memberFunction = (_data) => this.resourceStrings.igx_grid_pivot_date_dimension_total;
}