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/09/25 18:25:40 UTC

[GitHub] [echarts] sz-p opened a new pull request, #17698: feat(devInfo): set devInfo into axis component

sz-p opened a new pull request, #17698:
URL: https://github.com/apache/echarts/pull/17698

   <!-- Please fill in the following information to help us review your PR more efficiently. -->
   
   ## Brief Information
   
   This pull request is in the type of:
   
   - [ ] bug fixing
   - [x] new feature
   - [ ] others
   
   
   
   ### What does this PR do?
   
   +  set devInfo into axis component
   
   
   ### Fixed issues
   
   <!--
   - #xxxx: ...
   -->
   
   https://github.com/apache/echarts/issues/17697
   
   ## Details
   
   ### Before: What was the problem?
   
   <!-- DESCRIBE THE BUG OR REQUIREMENT HERE. -->
   
   <!-- ADD SCREENSHOT HERE IF APPLICABLE. -->
   
   
   
   ### After: How does it behave after the fixing?
   
   <!-- THE RESULT AFTER FIXING AND A SIMPLE EXPLANATION ABOUT HOW IT IS FIXED. -->
   
   <!-- ADD SCREENSHOT HERE IF APPLICABLE. -->
   
   
   
   ## Document Info
   
   One of the following should be checked.
   
   - [ ] This PR doesn't relate to document changes
   - [ ] The document should be updated later
   - [ ] The document changes have been made in apache/echarts-doc#xxx
   
   
   
   ## Misc
   
   ### ZRender Changes
   
   - [ ] This PR depends on ZRender changes (ecomfe/zrender#xxx).
   
   ### Related test cases or examples to use the new APIs
   
   N.A.
   
   
   
   ## Others
   
   ### Merging options
   
   - [ ] Please squash the commits into a single one when merging.
   
   ### Other information
   


-- 
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] pissang commented on pull request #17698: feat(devInfo): set devInfo into axis component

Posted by GitBox <gi...@apache.org>.
pissang commented on PR #17698:
URL: https://github.com/apache/echarts/pull/17698#issuecomment-1306985014

   Thanks for the work! This information are very useful in the visual editor of ECharts.
   
   Some suggestions or questions:
   
   1. The component level and sub-component level should be separated. For example:
   ```ts
   eCompName: 'barBackground'
   ```
   Is better to be
   ```ts
   component: 'series.bar',
   element: 'background' // Other name better than element will be appreciated.
   ```
   2. Naming should be consistent so it can be easily guessed by the developers. The naming rule should not expose the inside naming on the variables. For example:
   ```ts
   eCompName: 'candlestickEl'
   ```
   Is better to be
   ```ts
   component: 'series.candlestick'
   element: 'main' // Perhaps it can be optional if there is only one type of elements in the series. Which is the most common case
   ```
   
   ```ts
   eCompName: 'barRect'
   ```
   is better to be
   ```ts
   component: 'series.bar'
   element: 'main' // Perhaps it can be optional if there is only one type of elements in the series. Which is the most common case
   ```
   
   
   3. Should these information only available in the `__DEV__` mode so we can ship less code in the final productions. And we can provide a utility method to add this `__devInfo`
   ```ts
   if (__DEV__) {
     // The second parameters can be optional in most of series.
     addDevInfo(el, 'series.bar', 'main');
   }
   ```
   
   


-- 
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 pull request #17698: feat(devInfo): set devInfo into axis component

Posted by GitBox <gi...@apache.org>.
plainheart commented on PR #17698:
URL: https://github.com/apache/echarts/pull/17698#issuecomment-1258077850

   @sz-p Hi, thanks for your contribution! I marked this PR as a draft as it needs further discussion to determine the necessity, design, and implementation.


-- 
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] echarts-bot[bot] commented on pull request #17698: feat(devInfo): set devInfo into axis component

Posted by GitBox <gi...@apache.org>.
echarts-bot[bot] commented on PR #17698:
URL: https://github.com/apache/echarts/pull/17698#issuecomment-1257250580

   Thanks for your contribution!
   The community will review it ASAP. In the meanwhile, please checkout [the coding standard](https://echarts.apache.org/en/coding-standard.html) and Wiki about [How to make a pull request](https://github.com/apache/echarts/wiki/How-to-make-a-pull-request).
   
   ⚠️ MISSING DOCUMENT INFO: Please make sure one of the document options are checked in this PR's description. Search "Document Info" in the description of this PR. This should be done either by the author or the reviewers of the PR.


-- 
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