Interface LabelLayoutBase

src/label/labelLayoutHelper.ts:35–66

* This is the input for label layout and overlap resolving.

 * This is the input for label layout and overlap resolving.
 */
interface LabelLayoutBase {
    label: ZRText
    labelLine?: Polyline | NullUndefined
    layoutOption?: LabelLayoutOption | NullUndefined
    priority: number
    // @see `SavedLabelAttr` in `LabelManager.ts`
    defaultAttr: {
        ignore?: boolean
        labelGuideIgnore?: boolean
    }
    // To replace user specified `textMargin` or `minMargin`.
    // Format: `[top, right, bottom, left]`
    // e.g., `[0, null, 0, null]` means that the top and bottom margin is replaced as `0`,
    //  and use the original settings of left and right margin.
    marginForce?: (number | NullUndefined)[] | NullUndefined;
    // For backward compatibility for `minMargin`. `minMargin` can only be a number rather than number[],
    // some series only apply `minMargin` on top/bottom but disregard left/right.
    minMarginForce?: (number | NullUndefined)[] | NullUndefined;
    // If no `textMargin` and `minMargin` is specified, use this as default.
    // Format: `[top, right, bottom, left]`
    marginDefault?: number[] | NullUndefined;

    // In grid (Cartesian) estimation process (for `grid.containLabel` and related overflow resolving handlings),
    // the `gridRect` is shrunk gradually according to the last union boundingRect of the axis labels and names.
    // But the `ignore` strategy (such as in `hideOverlap` and `fixMinMaxLabelShow`) affects this process
    // significantly - the outermost labels might be determined `ignore:true` in a big `gridRect`, but be determined
    // `ignore:false` in a shrunk `gridRect`. (e.g., if the third label touches the outermost label in a shrunk
    // `gridRect`.) That probably causes the result overflowing unexpectedly.
    // Therefore, `suggestIgnore` is introduced to ensure the `ignore` consistent during that estimation process.
    // It suggests that this label has the lowest priority in ignore-if-overlap strategy.
    suggestIgnore?: boolean;
}
const LABEL_LAYOUT_BASE_PROPS = [
    'label', 'labelLine', 'layoutOption', 'priority', 'defaultAttr',
    'marginForce', 'minMarginForce', 'marginDefault', 'suggestIgnore'