Function createBoxLayoutReference

src/util/layout.ts:476–525

(
    model: ComponentModel,
    api: ExtensionAPI,
    opt?: CreateBoxLayoutReferenceOpt<TEnableByCenter>
)

 *      - Use `dataToLayout` to get the `refContainer`, such as, in matrix coord sys.
 */
export function createBoxLayoutReference<TEnableByCenter extends boolean = false>(
    model: ComponentModel,
    api: ExtensionAPI,
    opt?: CreateBoxLayoutReferenceOpt<TEnableByCenter>
): BoxLayoutReferenceResult<TEnableByCenter> {

    let refContainer: RectLike | NullUndefined;
    let refPoint: number[] | NullUndefined;
    let layoutRefType: BoxLayoutReferenceType | NullUndefined;

    const boxCoordSys = model.boxCoordinateSystem;
    let boxCoordFrom: BoxCoordinateSystemCoordFrom | NullUndefined;
    if (boxCoordSys) {
        const {coord, from} = getCoordForCoordSysUsageKindBox(model);
        // Do not use `clamp` in `dataToLayout` and `dataToPoint`, because:
        //  1. Should support overflow (such as, by dataZoom), where NaN should be in the result.
        //  2. Be consistent with the way used in `series.data`
        if (boxCoordSys.dataToLayout) {
            layoutRefType = BoxLayoutReferenceType.rect;
            boxCoordFrom = from;
            const result = boxCoordSys.dataToLayout(coord);
            refContainer = result.contentRect || result.rect;
        }
        else if (opt && opt.enableLayoutOnlyByCenter && boxCoordSys.dataToPoint) {
            layoutRefType = BoxLayoutReferenceType.point;
            boxCoordFrom = from;
            refPoint = boxCoordSys.dataToPoint(coord);
        }
        else {
            if (__DEV__) {
                error(`${model.type}[${model.componentIndex}]`
                    + ` layout based on ${boxCoordSys.type} is not supported.`
                );
            }
        }
    }

    if (layoutRefType == null) {
        layoutRefType = BoxLayoutReferenceType.rect;
    }

    if (layoutRefType === BoxLayoutReferenceType.rect) {
        if (!refContainer) {
            refContainer = {x: 0, y: 0, width: api.getWidth(), height: api.getHeight()};
        }
        refPoint = [refContainer.x + refContainer.width / 2, refContainer.y + refContainer.height / 2];
    }

    return {type: layoutRefType, refContainer, refPoint, boxCoordFrom} as BoxLayoutReferenceResult<TEnableByCenter>;
}


/**