[Bug] Callback for series-tree.symbol not defined in typescript

[theoarav]

Version

5.4.0

Link to Minimal Reproduction

https://echarts.apache.org/examples/en/editor.html?c=tree-polyline&lang=ts&code=MYewdgzgLgBAJgQygmBeGBvAUDGYEC2ApgFwwDkAZgDYIBOR5ANDjMABYCW1cDYZAbVa5suMXkKkKiZM2FiO3XkX4wh48aI3j8xMuVBgAbkTpRTEOdvGKefQfOuYJeigGFwJsxeYwjCagBXKQB2ACYARhgAXxYnTRcpcgARImpOAk5zOAAVIgAPKA9jU3M6X38gqQAWMIBOapjHDQBdZtxY9swu3F0k5KQEAFUobit4yuCyAGZpsLCu6Oa28U7NZr79OE4IAAdaAE9xmy47FQcnDET9ZM4zA4BlXbosxiY_AKmYAA5v2Zi4tYrpsKAAZThgIhPF7mCqfKQREJzAFdYGSfQAJSIwCg0NecKqMwAbGFpk1tCsxGsxFodOiKDQCscFKdlKoBGjXOQAGK0BgANR2BK-1QiESJMUpHUBIg29PIAEdgnQjjKWUp7GpUdcKABBADm-oY-qQRAAovlnkQIBBOOBhQiieKUZcdeRdWA4A6yBEAAxhEIuoFu3Uw9jEUbAb0wabfOpRanaTlJXVeBD6t4fQk_eNBpNugBCEPoBwtVptdrA0bCcbJiY0yf0HgIu3oO3t70mUgArH662qEiDyM3diBbeYywwKx2s19pkSQoH64P5R5AmAoNGQt8EwOaW6BuYRmNO_CyKLRXmGwedqMwDjo3V_sv90PJ9bbTOu2Re9NfVeVy5d9pzAABJMokBAcpT2zedEQA195W5KsYLnMJqn_F8RDdUDKGrJEwgQ7Ch1AiBdWrX1pjqIjnCHcEIOoaMIkiRosNo-UAFkkA4aNphCapvhoxsKC4_IMkCAho2-ap-1RHo3QjdgQDgSw9xODVzi1eJEK5BA4C9VCeyfGjAKSBBPV4v8TJ0sy0wzatviXNTryHUB103QyyADJz5OI-VtmgCEH08mB6kItjTK2TgjGjbs6m7ay_K5IgFVihpEvYrlKBQ2caiJTDnMiih9Q83KyHy2TtKSpISszb8YBJBKIps_ROEoPCQv4wTmuq1qIAQaNqidDLhPIahSvquKfKqzKknGuqzwaiJqJ62b9AIBB8gcyqqtGzIcvqmsdu0vblLS3dfLWigCECRiQoqka3UhVKQrilbCpaigwBACbFtjCVVtGqDeNJR6hyguBTAAI1VMqY19abdrdOhzPszrwjB-UIDSbFfuzeoAY-3qKGgfSiBikL52O-JRogQIoejfKCsu2mJIc5mZtGwJdhkBbYIRzGuX8F5zOAPm52mJqiau8gAHd2FMcWpHqd6WbdfJgcp7tWOl0b8gAfS2kKwiJVj5KlDQ2NGjiIXEySQuk6mivIAA5H6mO7bWhLdAB5aC4bqEIOeDIcAEVlVh-qIljOpCe1IcMVRpWfTinX4_lB4oBeMB9WPO64dFKyrbdB42c63Ni6Hfk2wQKHqGTmAxXQ72q5r-8G4iRy49dIcAA1NbhsVfQTZZ5HrWkxCHCBgACN5mlsNkLhD-VQIeGf6643Zqz9KX065cFIXoNfZ6Y6ZnUr-VQRAfVj_r3iIl7Fv5T97Z8GoW-G74oOn65cPzNGeuH9qwyV3j3eUf8NxZCQNFKE68G4CSoj_JIGIQA_SASFRE3Zu7Ly5OgguJturOVGh_HIBxdgd2-JEJB-gcgZFgSfV6fw6yj1WKwNo0QADcWAsAgF2KMcAaBui4CgKg8anBdhkAnlnTghpTCtXMPbeQ0jZF0B9qocgBAQCBGxpokw5BWDUmxi8a0S9ZTaCgGQpIWciBz20JwOAZBfR7iHNYogERmS4BkAgQQXiWgsGaCIiRFA_QAFIPEwHrpQKA-hvhhL3FDH6IiCD6HmHE5oLx9TsGiRQMIvo0nNAgAcAgCTqBkAABT1VDCjA4AAfMAEkoamHeK2FGBAIBkB9lDAAVrjAAlGgAAfBQBgwUClFJKQ8TgAAvUI_jtBEDgBmB47AEDkP0KOagBx0iQnCQsjM3IoIAGsAAKY4siVn0ESaYaS7FgHOQEHIDAiCpD4ewGYcyNDbKhBY-ukiuiy3sVAN5oVmidGaLQRppShHWChggYAhyjRaM9B4agUF9AAGJ2odS6KOccFyKCRI8l0LwkYAi6nSPqdRmR9J32cgEGR6iMlZP0doMF2h64IBMO06F7La5pD-dpXF5zwD6CZUS7SJLODr3JQy9a9i4C0vkvSyl-hCUsusEsVlHzxBEBbCs203KJ7iEoCAYA2itjWjFp6f-6rVjarEAUVsnoPRwBRbQXY2MyBZ2CHucyGRoHgGSIEFG_DVCeycc0P1G1Q1BpDZWIYPNTRkBCN2X0Y82FYE4UAA

Steps to Reproduce

Using example from official website Tree with polylines, set symbol parameter in the series to a callback:

symbol: (value: Array|number, params: Object) => 'rect',

Documentation reference: https://echarts.apache.org/en/option.html#series-tree.symbol

Current Behavior

The callback works but there is a typescript error :

Expected Behavior

The callback should be allowed in the type definition of series-tree.symbol and other items that accept callbacks.

Environment

- OS: macOS Monterey
- Browser: Chrome 107.0.5304.107
- Framework: Angular@14

Any additional comments?

No response

[theoarav]

Seems like the problems comes from the definition of the interface of TreeSeriesOption:

interface TreeSeriesOption extends SeriesOption<TreeSeriesStateOption, TreeStatesMixin>, TreeSeriesStateOption, SymbolOptionMixin, BoxLayoutOptionMixin, RoamOptionMixin {
    type?: 'tree';
    layout?: 'orthogonal' | 'radial';
    edgeShape?: 'polyline' | 'curve';
    /**
     * Available when edgeShape is polyline
     */
    edgeForkPosition?: string | number;
    nodeScaleRatio?: number;
    /**
     * The orient of orthoginal layout, can be setted to 'LR', 'TB', 'RL', 'BT'.
     * and the backward compatibility configuration 'horizontal = LR', 'vertical = TB'.
     */
    orient?: 'LR' | 'TB' | 'RL' | 'BT' | 'horizontal' | 'vertical';
    expandAndCollapse?: boolean;
    /**
     * The initial expanded depth of tree
     */
    initialTreeDepth?: number;
    leaves?: TreeSeriesLeavesOption;
    data?: TreeSeriesNodeItemOption[];
}

In the extends SymbolOptionMixin, there is no generic given to the interface.

interface SymbolOptionMixin<T = never> {
    /**
     * type of symbol, like `cirlce`, `rect`, or custom path and image.
     */
    symbol?: string | (T extends never ? never : SymbolCallback<T>);
    /**
     * Size of symbol.
     */
    symbolSize?: number | number[] | (T extends never ? never : SymbolSizeCallback<T>);
    symbolRotate?: number | (T extends never ? never : SymbolRotateCallback<T>);
    symbolKeepAspect?: boolean;
    symbolOffset?: string | number | (string | number)[] | (T extends never ? never : SymbolOffsetCallback<T>);
}

Maybe setting the extends SymbolOptionMixin to extends SymbolOptionMixin<CallbackDataParams> in the declaration of the interface CallbackDataParams, would solve this issue ?

[Ovilia]

It seems the callback function itself is working (symbol: () => 'triangle') but the type definition may be wrong. Are you interested in making a pull request?

[echarts-bot]

This issue is labeled with difficulty: easy.
@theoarmengou Would you like to debug it by yourself? This is a quicker way to get your problem fixed. Or you may wait for the community to fix.

Please have a look at How to debug ECharts if you'd like to give a try. 🤓