You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@echarts.apache.org by GitBox <gi...@apache.org> on 2022/07/04 12:20:02 UTC

[GitHub] [echarts] wang1212 opened a new issue, #17313: [Feature] Why is the `use()` extension mechanism not mentioned in the official documentation?

wang1212 opened a new issue, #17313:
URL: https://github.com/apache/echarts/issues/17313

   ### What problem does this feature solve?
   
   An official plugin/extension mechanism with safer and more flexible extension capabilities.
   
   ### What does the proposed API look like?
   
   When viewing the source code, the `use()` API provides a good extension mechanism and is fully used in the source code. 
   
   **Why is it not mentioned in the official documentation?** Or is it that I didn't find it? I have only got very limited information from the documentation for the import on demand section.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@echarts.apache.org.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@echarts.apache.org
For additional commands, e-mail: commits-help@echarts.apache.org


[GitHub] [echarts] plainheart commented on issue #17313: [Feature] Why is the `use()` extension mechanism not mentioned in the official documentation?

Posted by GitBox <gi...@apache.org>.
plainheart commented on issue #17313:
URL: https://github.com/apache/echarts/issues/17313#issuecomment-1173856635

   It's mentioned at https://echarts.apache.org/api.html#echarts.use. What information are you expecting to get more?


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@echarts.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@echarts.apache.org
For additional commands, e-mail: commits-help@echarts.apache.org


[GitHub] [echarts] wang1212 commented on issue #17313: [Feature] Why is the `use()` extension mechanism not mentioned in the official documentation?

Posted by GitBox <gi...@apache.org>.
wang1212 commented on issue #17313:
URL: https://github.com/apache/echarts/issues/17313#issuecomment-1174672532

   > The APIs mounted in the global `echarts` usually are safe to be used by the developers. Please rest assured to use the `use` API.
   
   Ok, I see. Thank you very much for your prompt reply.
   
   ---
   
   To say some digressions, after a preliminary understanding, it is a good mechanism to use the `use()` API to extend ECharts, but the relevant information on the Internet is very limited (or even no), I hope this mechanism can be known by more people , in order to facilitate users to realize personalized functions in specific scenarios.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@echarts.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@echarts.apache.org
For additional commands, e-mail: commits-help@echarts.apache.org


[GitHub] [echarts] wang1212 closed issue #17313: [Feature] Why is the `use()` extension mechanism not mentioned in the official documentation?

Posted by GitBox <gi...@apache.org>.
wang1212 closed issue #17313: [Feature] Why is the `use()` extension mechanism not mentioned in the official documentation?
URL: https://github.com/apache/echarts/issues/17313


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@echarts.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@echarts.apache.org
For additional commands, e-mail: commits-help@echarts.apache.org


[GitHub] [echarts] wang1212 commented on issue #17313: [Feature] Why is the `use()` extension mechanism not mentioned in the official documentation?

Posted by GitBox <gi...@apache.org>.
wang1212 commented on issue #17313:
URL: https://github.com/apache/echarts/issues/17313#issuecomment-1173888534

   > It's mentioned at [echarts.apache.org/api.html#echarts.use](https://echarts.apache.org/api.html#echarts.use). What information are you expecting to get more?
   
   I'm concerned with **how to extend echarts** instead of using `use()` to implement on-demand import.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@echarts.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@echarts.apache.org
For additional commands, e-mail: commits-help@echarts.apache.org


[GitHub] [echarts] wang1212 commented on issue #17313: [Feature] Why is the `use()` extension mechanism not mentioned in the official documentation?

Posted by GitBox <gi...@apache.org>.
wang1212 commented on issue #17313:
URL: https://github.com/apache/echarts/issues/17313#issuecomment-1174627103

   > Got it. But I'm afraid you have to read the source to learn about the related usage. We have no available documentation to indicate so many internal APIs yet.
   
   Actually, I'm just trying to figure out why this extension mechanism API is not mentioned in the official documentation.
   
   If it's just because the maintenance team doesn't have time to write documentation, there's nothing to worry about. However, if the APIs seen from the source code are not officially recommended, is there a big risk in using these APIs?
   
   In other words, I see from the source code that the `use()` API is the official way to expose (register) various chart components and is widely used, so can I consider this extension mechanism to be stable at present , **is it safe to use by external users**?


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@echarts.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@echarts.apache.org
For additional commands, e-mail: commits-help@echarts.apache.org


[GitHub] [echarts] plainheart commented on issue #17313: [Feature] Why is the `use()` extension mechanism not mentioned in the official documentation?

Posted by GitBox <gi...@apache.org>.
plainheart commented on issue #17313:
URL: https://github.com/apache/echarts/issues/17313#issuecomment-1173898586

   Got it. But I'm afraid you have to read the source to learn about the related usage. We have no available documentation to indicate so many internal APIs yet.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@echarts.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@echarts.apache.org
For additional commands, e-mail: commits-help@echarts.apache.org


[GitHub] [echarts] plainheart commented on issue #17313: [Feature] Why is the `use()` extension mechanism not mentioned in the official documentation?

Posted by GitBox <gi...@apache.org>.
plainheart commented on issue #17313:
URL: https://github.com/apache/echarts/issues/17313#issuecomment-1174666744

   The APIs mounted in the global `echarts` usually are safe to be used by the developers. Please rest assured to use the `use` API.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@echarts.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@echarts.apache.org
For additional commands, e-mail: commits-help@echarts.apache.org