@gooddata/react-components/src/internal/utils/mdObjectHelper.ts

GoodData.UI - A powerful JavaScript library for building analytical applications

// (C) 2019-2020 GoodData Corporation
import get = require("lodash/get");
import { VisualizationObject } from "@gooddata/typings";
import * as BucketNames from "../../constants/bucketNames";
import { IVisualizationPropertiesControls } from "../interfaces/Visualization";
import {
    isBarChart,
    isBubbleChart,
    isBulletChart,
    isScatterPlot,
} from "../../components/visualizations/utils/common";
import { getBucketItems } from "../../helpers/mdObjBucketHelper";
import { areAllMeasuresOnSingleAxis, getMeasuresFromMdObject } from "../../helpers/MdObjectHelper";

function isAttribute(item: VisualizationObject.BucketItem): boolean {
    const attribute = item as VisualizationObject.IVisualizationAttribute;
    return attribute.visualizationAttribute !== undefined;
}

function findBucketByLocalIdentifier(buckets: VisualizationObject.IBucket[], bucketName: string) {
    return (buckets || []).find(bucket => get(bucket, "localIdentifier") === bucketName);
}

export function hasAttribute(mdObject: VisualizationObject.IVisualizationObjectContent): boolean {
    return mdObject.buckets.some(bucket => {
        return bucket.items.some(isAttribute);
    });
}

export function haveManyViewItems(mdObject: VisualizationObject.IVisualizationObjectContent): boolean {
    const viewBucket = mdObject && findBucketByLocalIdentifier(mdObject.buckets, BucketNames.VIEW);
    return viewBucket && get(viewBucket, "items").length > 1;
}

export function hasOneViewItem(mdObject: VisualizationObject.IVisualizationObjectContent): boolean {
    const viewBucket = mdObject && findBucketByLocalIdentifier(mdObject.buckets, BucketNames.VIEW);
    return viewBucket && get(viewBucket, "items").length === 1;
}

export function hasTertiaryMeasures(mdObject: VisualizationObject.IVisualizationObjectContent): boolean {
    return mdObject.buckets
        .filter(bucket => [BucketNames.TERTIARY_MEASURES].indexOf(get(bucket, "localIdentifier")) >= 0)
        .some(bucket => get(bucket, "items").length > 0);
}

export function isStacked(mdObject: VisualizationObject.IVisualizationObjectContent): boolean {
    return (
        mdObject &&
        mdObject.buckets
            .filter(
                bucket =>
                    [BucketNames.STACK, BucketNames.SEGMENT].indexOf(get(bucket, "localIdentifier")) >= 0,
            )
            .some(bucket => get(bucket, "items").length > 0)
    );
}

export function hasMeasures(mdObject: VisualizationObject.IVisualizationObjectContent): boolean {
    return mdObject && getMeasuresFromMdObject(mdObject).length > 0;
}

export function hasColorMeasure(mdObject: VisualizationObject.IVisualizationObjectContent): boolean {
    const colorBucket = mdObject && findBucketByLocalIdentifier(mdObject.buckets, BucketNames.COLOR);
    return colorBucket && get(colorBucket, "items").length > 0;
}

export function hasSizeMeasure(mdObject: VisualizationObject.IVisualizationObjectContent): boolean {
    const sizeBucket = mdObject && findBucketByLocalIdentifier(mdObject.buckets, BucketNames.SIZE);
    return sizeBucket && get(sizeBucket, "items").length > 0;
}

export function hasLocationAttribute(mdObject: VisualizationObject.IVisualizationObjectContent): boolean {
    if (!mdObject) {
        return false;
    }

    return getBucketItems(mdObject.buckets, BucketNames.LOCATION).length > 0;
}

export function hasSegmentAttribute(mdObject: VisualizationObject.IVisualizationObjectContent): boolean {
    if (!mdObject) {
        return false;
    }

    return getBucketItems(mdObject.buckets, BucketNames.SEGMENT).length > 0;
}

// don't support sort by total value for dual axis
export function canSortStackTotalValue(
    mdObject: VisualizationObject.IVisualizationObjectContent,
    supportedControls: IVisualizationPropertiesControls,
    enableSortingByTotalGroup: boolean = false,
): boolean {
    const isSingleAxisAndStacked: boolean =
        get(supportedControls, "stackMeasures", false) &&
        areAllMeasuresOnSingleAxis(mdObject, get(supportedControls, "secondary_yaxis", false));

    if (enableSortingByTotalGroup) {
        return isSingleAxisAndStacked;
    }

    return isSingleAxisAndStacked && hasOneViewItem(mdObject);
}

export function countItemsInMdObject(mdObject: VisualizationObject.IVisualizationObjectContent) {
    if (!mdObject) {
        return {};
    }

    const { buckets } = mdObject;

    const viewByItemCount: number = getBucketItems(buckets, BucketNames.VIEW).length;
    const measureItemCount: number = getBucketItems(buckets, BucketNames.MEASURES).length;
    const secondaryMeasureItemCount: number = getBucketItems(buckets, BucketNames.SECONDARY_MEASURES).length;

    return {
        viewByItemCount,
        measureItemCount,
        secondaryMeasureItemCount,
    };
}

export function countItemsOnAxes(
    type: string,
    controls: IVisualizationPropertiesControls,
    mdObject: VisualizationObject.IVisualizationObjectContent,
) {
    const isBarFamilyChartType = isBarChart(type) || isBulletChart(type);

    const { viewByItemCount, measureItemCount, secondaryMeasureItemCount } = countItemsInMdObject(mdObject);
    const totalMeasureItemCount = measureItemCount + secondaryMeasureItemCount;

    const secondaryMeasureCountInConfig = (isBarFamilyChartType
        ? get(controls, "secondary_xaxis.measures", [])
        : get(controls, "secondary_yaxis.measures", [])
    ).length;

    if (isBarFamilyChartType) {
        return {
            yaxis: viewByItemCount,
            xaxis: totalMeasureItemCount - secondaryMeasureCountInConfig,
            secondary_xaxis: secondaryMeasureCountInConfig,
        };
    }

    if (isScatterPlot(type) || isBubbleChart(type)) {
        return {
            xaxis: measureItemCount,
            yaxis: secondaryMeasureItemCount,
        };
    }

    return {
        xaxis: viewByItemCount,
        yaxis: totalMeasureItemCount - secondaryMeasureCountInConfig,
        secondary_yaxis: secondaryMeasureCountInConfig,
    };
}

export function isDisplayFormUri(
    displayForm: VisualizationObject.IObjUriQualifier | VisualizationObject.IObjIdentifierQualifier,
): displayForm is VisualizationObject.IObjUriQualifier {
    return displayForm.hasOwnProperty("uri");
}