zrender-nightly 5.6.1-dev.20241122 → 5.6.1-dev.20241124

package/lib/graphic/Text.d.ts

@@ -90,6 +90,7 @@ declare class ZRText extends Displayable<TextProps> implements GroupLike {
     style: TextStyleProps;
     overlap: 'hidden' | 'show' | 'blur';
     innerTransformable: Transformable;
+    isTruncated: boolean;
     private _children;
     private _childCursor;
     private _defaultStyle;

package/lib/graphic/Text.js

@@ -195,6 +195,7 @@ var ZRText = (function (_super) {
         var textLines = contentBlock.lines;
         var lineHeight = contentBlock.lineHeight;
         var defaultStyle = this._defaultStyle;
+        this.isTruncated = !!contentBlock.isTruncated;
         var baseX = style.x || 0;
         var baseY = style.y || 0;
         var textAlign = style.align || defaultStyle.align || 'left';
@@ -278,6 +279,7 @@ var ZRText = (function (_super) {
         var defaultStyle = this._defaultStyle;
         var textAlign = style.align || defaultStyle.align;
         var verticalAlign = style.verticalAlign || defaultStyle.verticalAlign;
+        this.isTruncated = !!contentBlock.isTruncated;
         var boxX = adjustTextX(baseX, outerWidth, textAlign);
         var boxY = adjustTextY(baseY, outerHeight, verticalAlign);
         var xLeft = boxX;

package/lib/graphic/helper/parseText.d.ts

@@ -17,6 +17,7 @@ export interface PlainTextContentBlock {
     outerWidth: number;
     outerHeight: number;
     lines: string[];
+    isTruncated: boolean;
 }
 export declare function parsePlainText(text: string, style?: TextStyleProps): PlainTextContentBlock;
 declare class RichTextToken {
@@ -49,6 +50,7 @@ export declare class RichTextContentBlock {
     outerWidth: number;
     outerHeight: number;
     lines: RichTextLine[];
+    isTruncated: boolean;
 }
 export declare function parseRichText(text: string, style: TextStyleProps): RichTextContentBlock;
 export {};

package/lib/graphic/helper/parseText.js

@@ -3,15 +3,27 @@ import { extend, retrieve2, retrieve3, reduce } from '../../core/util.js';
 import { getLineHeight, getWidth, parsePercent } from '../../contain/text.js';
 var STYLE_REG = /\{([a-zA-Z0-9_]+)\|([^}]*)\}/g;
 export function truncateText(text, containerWidth, font, ellipsis, options) {
+    var out = {};
+    truncateText2(out, text, containerWidth, font, ellipsis, options);
+    return out.text;
+}
+function truncateText2(out, text, containerWidth, font, ellipsis, options) {
     if (!containerWidth) {
-        return '';
+        out.text = '';
+        out.isTruncated = false;
+        return;
     }
     var textLines = (text + '').split('\n');
     options = prepareTruncateOptions(containerWidth, font, ellipsis, options);
+    var isTruncated = false;
+    var truncateOut = {};
     for (var i = 0, len = textLines.length; i < len; i++) {
-        textLines[i] = truncateSingleLine(textLines[i], options);
+        truncateSingleLine(truncateOut, textLines[i], options);
+        textLines[i] = truncateOut.textLine;
+        isTruncated = isTruncated || truncateOut.isTruncated;
     }
-    return textLines.join('\n');
+    out.text = textLines.join('\n');
+    out.isTruncated = isTruncated;
 }
 function prepareTruncateOptions(containerWidth, font, ellipsis, options) {
     options = options || {};
@@ -39,16 +51,20 @@ function prepareTruncateOptions(containerWidth, font, ellipsis, options) {
     preparedOpts.containerWidth = containerWidth;
     return preparedOpts;
 }
-function truncateSingleLine(textLine, options) {
+function truncateSingleLine(out, textLine, options) {
     var containerWidth = options.containerWidth;
     var font = options.font;
     var contentWidth = options.contentWidth;
     if (!containerWidth) {
-        return '';
+        out.textLine = '';
+        out.isTruncated = false;
+        return;
     }
     var lineWidth = getWidth(textLine, font);
     if (lineWidth <= containerWidth) {
-        return textLine;
+        out.textLine = textLine;
+        out.isTruncated = false;
+        return;
     }
     for (var j = 0;; j++) {
         if (lineWidth <= contentWidth || j >= options.maxIterations) {
@@ -66,7 +82,8 @@ function truncateSingleLine(textLine, options) {
     if (textLine === '') {
         textLine = options.placeholder;
     }
-    return textLine;
+    out.textLine = textLine;
+    out.isTruncated = true;
 }
 function estimateLength(text, contentWidth, ascCharWidth, cnCharWidth) {
     var width = 0;
@@ -87,6 +104,7 @@ export function parsePlainText(text, style) {
     var lineHeight = retrieve2(style.lineHeight, calculatedLineHeight);
     var bgColorDrawn = !!(style.backgroundColor);
     var truncateLineOverflow = style.lineOverflow === 'truncate';
+    var isTruncated = false;
     var width = style.width;
     var lines;
     if (width != null && (overflow === 'break' || overflow === 'breakAll')) {
@@ -99,6 +117,7 @@ export function parsePlainText(text, style) {
     var height = retrieve2(style.height, contentHeight);
     if (contentHeight > height && truncateLineOverflow) {
         var lineCount = Math.floor(height / lineHeight);
+        isTruncated = isTruncated || (lines.length > lineCount);
         lines = lines.slice(0, lineCount);
     }
     if (text && truncate && width != null) {
@@ -106,8 +125,11 @@ export function parsePlainText(text, style) {
             minChar: style.truncateMinChar,
             placeholder: style.placeholder
         });
+        var singleOut = {};
         for (var i = 0; i < lines.length; i++) {
-            lines[i] = truncateSingleLine(lines[i], options);
+            truncateSingleLine(singleOut, lines[i], options);
+            lines[i] = singleOut.textLine;
+            isTruncated = isTruncated || singleOut.isTruncated;
         }
     }
     var outerHeight = height;
@@ -136,7 +158,8 @@ export function parsePlainText(text, style) {
         calculatedLineHeight: calculatedLineHeight,
         contentWidth: contentWidth,
         contentHeight: contentHeight,
-        width: width
+        width: width,
+        isTruncated: isTruncated
     };
 }
 var RichTextToken = (function () {
@@ -162,6 +185,7 @@ var RichTextContentBlock = (function () {
         this.outerWidth = 0;
         this.outerHeight = 0;
         this.lines = [];
+        this.isTruncated = false;
     }
     return RichTextContentBlock;
 }());
@@ -197,6 +221,7 @@ export function parseRichText(text, style) {
     var stlPadding = style.padding;
     var truncate = overflow === 'truncate';
     var truncateLine = style.lineOverflow === 'truncate';
+    var tmpTruncateOut = {};
     function finishLine(line, lineWidth, lineHeight) {
         line.width = lineWidth;
         line.lineHeight = lineHeight;
@@ -222,6 +247,7 @@ export function parseRichText(text, style) {
             token.align = tokenStyle && tokenStyle.align || style.align;
             token.verticalAlign = tokenStyle && tokenStyle.verticalAlign || 'middle';
             if (truncateLine && topHeight != null && calculatedHeight + token.lineHeight > topHeight) {
+                var originalLength = contentBlock.lines.length;
                 if (j > 0) {
                     line.tokens = line.tokens.slice(0, j);
                     finishLine(line, lineWidth, lineHeight);
@@ -230,6 +256,7 @@ export function parseRichText(text, style) {
                 else {
                     contentBlock.lines = contentBlock.lines.slice(0, i);
                 }
+                contentBlock.isTruncated = contentBlock.isTruncated || (contentBlock.lines.length < originalLength);
                 break outer;
             }
             var styleTokenWidth = tokenStyle.width;
@@ -258,7 +285,9 @@ export function parseRichText(text, style) {
                         token.width = token.contentWidth = 0;
                     }
                     else {
-                        token.text = truncateText(token.text, remainTruncWidth - paddingH, font, style.ellipsis, { minChar: style.truncateMinChar });
+                        truncateText2(tmpTruncateOut, token.text, remainTruncWidth - paddingH, font, style.ellipsis, { minChar: style.truncateMinChar });
+                        token.text = tmpTruncateOut.text;
+                        contentBlock.isTruncated = contentBlock.isTruncated || tmpTruncateOut.isTruncated;
                         token.width = token.contentWidth = getWidth(token.text, font);
                     }
                 }

package/lib/zrender.d.ts

@@ -90,7 +90,7 @@ export declare type ElementSSRData = zrUtil.HashMap<unknown>;
 export declare type ElementSSRDataGetter<T> = (el: Element) => zrUtil.HashMap<T>;
 export declare function getElementSSRData(el: Element): ElementSSRData;
 export declare function registerSSRDataGetter<T>(getter: ElementSSRDataGetter<T>): void;
-export declare const version = "5.6.1-dev.20241122";
+export declare const version = "5.6.1-dev.20241124";
 export interface ZRenderType extends ZRender {
 }
 export {};

package/lib/zrender.js

@@ -324,5 +324,5 @@ export function getElementSSRData(el) {
 export function registerSSRDataGetter(getter) {
     ssrDataGetter = getter;
 }
-export var version = '5.6.1-dev.20241122';
+export var version = '5.6.1-dev.20241124';
 ;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zrender-nightly",
-  "version": "5.6.1-dev.20241122",
+  "version": "5.6.1-dev.20241124",
   "description": "A lightweight graphic library providing 2d draw for Apache ECharts",
   "keywords": [
     "canvas",

package/src/graphic/Text.ts

@@ -275,6 +275,12 @@ class ZRText extends Displayable<TextProps> implements GroupLike {
      */
     innerTransformable: Transformable
 
+    // Be `true` if and only if the result text is modified due to overflow, due to
+    // settings on either `overflow` or `lineOverflow`. Based on this the caller can
+    // take some action like showing the original text in a particular tip.
+    // Only take effect after rendering. So do not visit it before it.
+    isTruncated: boolean
+
     private _children: (ZRImage | Rect | TSpan)[] = []
 
     private _childCursor: 0
@@ -497,6 +503,8 @@ class ZRText extends Displayable<TextProps> implements GroupLike {
 
         const defaultStyle = this._defaultStyle;
 
+        this.isTruncated = !!contentBlock.isTruncated;
+
         const baseX = style.x || 0;
         const baseY = style.y || 0;
         const textAlign = style.align || defaultStyle.align || 'left';
@@ -635,6 +643,8 @@ class ZRText extends Displayable<TextProps> implements GroupLike {
         const textAlign = style.align || defaultStyle.align;
         const verticalAlign = style.verticalAlign || defaultStyle.verticalAlign;
 
+        this.isTruncated = !!contentBlock.isTruncated;
+
         const boxX = adjustTextX(baseX, outerWidth, textAlign);
         const boxY = adjustTextY(baseY, outerHeight, verticalAlign);
         let xLeft = boxX;

package/src/graphic/helper/parseText.ts

@@ -44,8 +44,25 @@ export function truncateText(
     ellipsis?: string,
     options?: InnerTruncateOption
 ): string {
+    const out = {} as Parameters<typeof truncateText2>[0];
+    truncateText2(out, text, containerWidth, font, ellipsis, options);
+    return out.text;
+}
+
+// PENDING: not sure whether `truncateText` is used outside zrender, since it has an `export`
+// specifier. So keep it and perform the interface modification in `truncateText2`.
+function truncateText2(
+    out: {text: string, isTruncated: boolean},
+    text: string,
+    containerWidth: number,
+    font: string,
+    ellipsis?: string,
+    options?: InnerTruncateOption
+): void {
     if (!containerWidth) {
-        return '';
+        out.text = '';
+        out.isTruncated = false;
+        return;
     }
 
     const textLines = (text + '').split('\n');
@@ -53,11 +70,16 @@ export function truncateText(
 
     // FIXME
     // It is not appropriate that every line has '...' when truncate multiple lines.
+    let isTruncated = false;
+    const truncateOut = {} as Parameters<typeof truncateSingleLine>[0];
     for (let i = 0, len = textLines.length; i < len; i++) {
-        textLines[i] = truncateSingleLine(textLines[i], options as InnerPreparedTruncateOption);
+        truncateSingleLine(truncateOut, textLines[i], options as InnerPreparedTruncateOption);
+        textLines[i] = truncateOut.textLine;
+        isTruncated = isTruncated || truncateOut.isTruncated;
     }
 
-    return textLines.join('\n');
+    out.text = textLines.join('\n');
+    out.isTruncated = isTruncated;
 }
 
 function prepareTruncateOptions(
@@ -104,19 +126,27 @@ function prepareTruncateOptions(
     return preparedOpts;
 }
 
-function truncateSingleLine(textLine: string, options: InnerPreparedTruncateOption): string {
+function truncateSingleLine(
+    out: {textLine: string, isTruncated: boolean},
+    textLine: string,
+    options: InnerPreparedTruncateOption
+): void {
     const containerWidth = options.containerWidth;
     const font = options.font;
     const contentWidth = options.contentWidth;
 
     if (!containerWidth) {
-        return '';
+        out.textLine = '';
+        out.isTruncated = false;
+        return;
     }
 
     let lineWidth = getWidth(textLine, font);
 
     if (lineWidth <= containerWidth) {
-        return textLine;
+        out.textLine = textLine;
+        out.isTruncated = false;
+        return;
     }
 
     for (let j = 0; ; j++) {
@@ -139,7 +169,8 @@ function truncateSingleLine(textLine: string, options: InnerPreparedTruncateOpti
         textLine = options.placeholder;
     }
 
-    return textLine;
+    out.textLine = textLine;
+    out.isTruncated = true;
 }
 
 function estimateLength(
@@ -174,6 +205,10 @@ export interface PlainTextContentBlock {
     outerHeight: number
 
     lines: string[]
+
+    // Be `true` if and only if the result text is modified due to overflow, due to
+    // settings on either `overflow` or `lineOverflow`
+    isTruncated: boolean
 }
 
 export function parsePlainText(
@@ -192,6 +227,7 @@ export function parsePlainText(
     const bgColorDrawn = !!(style.backgroundColor);
 
     const truncateLineOverflow = style.lineOverflow === 'truncate';
+    let isTruncated = false;
 
     let width = style.width;
     let lines: string[];
@@ -210,6 +246,7 @@ export function parsePlainText(
     if (contentHeight > height && truncateLineOverflow) {
         const lineCount = Math.floor(height / lineHeight);
 
+        isTruncated = isTruncated || (lines.length > lineCount);
         lines = lines.slice(0, lineCount);
 
         // TODO If show ellipse for line truncate
@@ -228,8 +265,11 @@ export function parsePlainText(
             placeholder: style.placeholder
         });
         // Having every line has '...' when truncate multiple lines.
+        const singleOut = {} as Parameters<typeof truncateSingleLine>[0];
         for (let i = 0; i < lines.length; i++) {
-            lines[i] = truncateSingleLine(lines[i], options);
+            truncateSingleLine(singleOut, lines[i], options);
+            lines[i] = singleOut.textLine;
+            isTruncated = isTruncated || singleOut.isTruncated;
         }
     }
 
@@ -265,7 +305,8 @@ export function parsePlainText(
         calculatedLineHeight: calculatedLineHeight,
         contentWidth: contentWidth,
         contentHeight: contentHeight,
-        width: width
+        width: width,
+        isTruncated: isTruncated
     };
 }
 
@@ -314,6 +355,9 @@ export class RichTextContentBlock {
     outerWidth: number = 0
     outerHeight: number = 0
     lines: RichTextLine[] = []
+    // Be `true` if and only if the result text is modified due to overflow, due to
+    // settings on either `overflow` or `lineOverflow`
+    isTruncated: boolean = false
 }
 
 type WrapInfo = {
@@ -326,7 +370,7 @@ type WrapInfo = {
  * Also consider 'bbbb{a|xxx\nzzz}xxxx\naaaa'.
  * If styleName is undefined, it is plain text.
  */
-export function parseRichText(text: string, style: TextStyleProps) {
+export function parseRichText(text: string, style: TextStyleProps): RichTextContentBlock {
     const contentBlock = new RichTextContentBlock();
 
     text != null && (text += '');
@@ -366,6 +410,7 @@ export function parseRichText(text: string, style: TextStyleProps) {
 
     const truncate = overflow === 'truncate';
     const truncateLine = style.lineOverflow === 'truncate';
+    const tmpTruncateOut = {} as Parameters<typeof truncateText2>[0];
 
     // let prevToken: RichTextToken;
 
@@ -412,6 +457,7 @@ export function parseRichText(text: string, style: TextStyleProps) {
             if (truncateLine && topHeight != null && calculatedHeight + token.lineHeight > topHeight) {
                 // TODO Add ellipsis on the previous token.
                 // prevToken.text =
+                const originalLength = contentBlock.lines.length;
                 if (j > 0) {
                     line.tokens = line.tokens.slice(0, j);
                     finishLine(line, lineWidth, lineHeight);
@@ -420,6 +466,7 @@ export function parseRichText(text: string, style: TextStyleProps) {
                 else {
                     contentBlock.lines = contentBlock.lines.slice(0, i);
                 }
+                contentBlock.isTruncated = contentBlock.isTruncated || (contentBlock.lines.length < originalLength);
                 break outer;
             }
 
@@ -461,10 +508,13 @@ export function parseRichText(text: string, style: TextStyleProps) {
                         token.width = token.contentWidth = 0;
                     }
                     else {
-                        token.text = truncateText(
+                        truncateText2(
+                            tmpTruncateOut,
                             token.text, remainTruncWidth - paddingH, font, style.ellipsis,
                             {minChar: style.truncateMinChar}
                         );
+                        token.text = tmpTruncateOut.text;
+                        contentBlock.isTruncated = contentBlock.isTruncated || tmpTruncateOut.isTruncated;
                         token.width = token.contentWidth = getWidth(token.text, font);
                     }
                 }

package/src/zrender.ts

@@ -556,7 +556,7 @@ export function registerSSRDataGetter<T>(getter: ElementSSRDataGetter<T>) {
 /**
  * @type {string}
  */
-export const version = '5.6.1-dev.20241122';
+export const version = '5.6.1-dev.20241124';
 
 
 export interface ZRenderType extends ZRender {};