Function decideCoordSysUsageKind

src/core/CoordinateSystem.ts:186–233

(
    // Component or series
    model: ComponentModel,
    printError?: boolean
)

    | typeof COORD_SYS_USAGE_KIND_BOX;

export function decideCoordSysUsageKind(
    // Component or series
    model: ComponentModel,
    printError?: boolean
): {
    kind: CoordinateSystemUsageKind;
    coordSysType: string | NullUndefined;
} {
    // For backward compat, still not use `true` in model.get.
    const coordSysType = model.getShallow('coordinateSystem');
    let coordSysUsageOption = model.getShallow('coordinateSystemUsage', true);
    const isDeclaredExplicitly = coordSysUsageOption != null;
    let kind: CoordinateSystemUsageKind = COORD_SYS_USAGE_KIND_NONE;

    if (coordSysType) {
        const isSeries = model.mainType === 'series';
        if (coordSysUsageOption == null) {
            coordSysUsageOption = isSeries ? 'data' : 'box';
        }

        if (coordSysUsageOption === 'data') {
            kind = COORD_SYS_USAGE_KIND_DATA;
            if (!isSeries) {
                if (__DEV__) {
                    if (isDeclaredExplicitly && printError) {
                        error('coordinateSystemUsage "data" is not supported in non-series components.');
                    }
                }
                kind = COORD_SYS_USAGE_KIND_NONE;
            }
        }
        else if (coordSysUsageOption === 'box') {
            kind = COORD_SYS_USAGE_KIND_BOX;
            if (!isSeries && !canBeNonSeriesBoxCoordSys(coordSysType)) {
                if (__DEV__) {
                    if (isDeclaredExplicitly && printError) {
                        error(`coordinateSystem "${coordSysType}" cannot be used`
                            + ` as coordinateSystemUsage "box" for "${model.type}" yet.`
                        );
                    }
                }
                kind = COORD_SYS_USAGE_KIND_NONE;
            }
        }
    }

    return {coordSysType, kind};
}

/**
 * These cases are considered: