Function computeLabelGeometry

src/label/labelLayoutHelper.ts:156–215

(
    out: Partial<TOut>,
    label: ZRText,
    opt?: Pick<LabelLayoutData, 'marginForce' | 'minMarginForce' | 'marginDefault'>
)

 * The props in `out` will be filled if existing, or created.
 */
export function computeLabelGeometry<TOut extends LabelGeometry>(
    out: Partial<TOut>,
    label: ZRText,
    opt?: Pick<LabelLayoutData, 'marginForce' | 'minMarginForce' | 'marginDefault'>
): TOut {
    // [CAUTION] These props may be modified directly for performance consideration,
    //  therefore, do not output the internal data structure of zrender Element.

    const rawTransform = label.getComputedTransform();
    out.transform = ensureCopyTransform(out.transform, rawTransform);

    // NOTE: should call `getBoundingRect` after `getComputedTransform`, or may get an inaccurate bounding rect.
    //  The reason is that `getComputedTransform` calls `__host.updateInnerText()` internally, which updates the label
    //  by `textConfig` mounted on the host.
    // PENDING: add a dirty bit for that in zrender?
    const outLocalRect = out.localRect = ensureCopyRect(out.localRect, label.getBoundingRect());

    const labelStyleExt = label.style as LabelExtendedTextStyle;
    let margin = labelStyleExt.margin;
    const marginForce = opt && opt.marginForce;
    const minMarginForce = opt && opt.minMarginForce;
    const marginDefault = opt && opt.marginDefault;
    let marginType = labelStyleExt.__marginType;
    if (marginType == null && marginDefault) {
        margin = marginDefault;
        marginType = LabelMarginType.textMargin;
    }
    // `textMargin` and `minMargin` can not exist both.
    for (let i = 0; i < 4; i++) {
        _tmpLabelMargin[i] =
            (marginType === LabelMarginType.minMargin && minMarginForce && minMarginForce[i] != null)
            ? minMarginForce[i]
            : (marginForce && marginForce[i] != null)
            ? marginForce[i]
            : (margin ? margin[i] : 0);
    }
    if (marginType === LabelMarginType.textMargin) {
        expandOrShrinkRect(outLocalRect, _tmpLabelMargin, false, false);
    }

    const outGlobalRect = out.rect = ensureCopyRect(out.rect, outLocalRect);
    if (rawTransform) {
        outGlobalRect.applyTransform(rawTransform);
    }

    // Notice: label.style.margin is actually `minMargin / 2`, handled by `setTextStyleCommon`.
    if (marginType === LabelMarginType.minMargin) {
        expandOrShrinkRect(outGlobalRect, _tmpLabelMargin, false, false);
    }

    out.axisAligned = isBoundingRectAxisAligned(rawTransform);

    (out.label = out.label || {} as TOut['label']).ignore = label.ignore;

    setLabelLayoutDirty(out as TOut, false);
    setLabelLayoutDirty(out as TOut, true, LABEL_LAYOUT_DIRTY_BIT_OBB);
    // Do not remove `obb` (if existing) for reuse, just reset the dirty bit.