[GitHub] [echarts] plainheart commented on a diff in pull request #17529: feat(type): export helpful types and APIs for extension developers

[GitBox <gi...@apache.org>]

plainheart commented on code in PR #17529:
URL: https://github.com/apache/echarts/pull/17529#discussion_r949787454


##########
src/export/extensionAPI.ts:
##########
@@ -0,0 +1,72 @@
+/*
+* Licensed to the Apache Software Foundation (ASF) under one
+* or more contributor license agreements.  See the NOTICE file
+* distributed with this work for additional information
+* regarding copyright ownership.  The ASF licenses this file
+* to you under the Apache License, Version 2.0 (the
+* "License"); you may not use this file except in compliance
+* with the License.  You may obtain a copy of the License at
+*
+*   http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing,
+* software distributed under the License is distributed on an
+* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+* KIND, either express or implied.  See the License for the
+* specific language governing permissions and limitations
+* under the License.
+*/
+
+// These APIs are for more advanced usages
+// For example extend charts and components, creating graphic elements, formatting.
+import ComponentModel, { ComponentModelConstructor } from '../model/Component';

Review Comment:
   > Will this extensionAPI file name being confused with the echarts/src/core/ExtensionAPI ?
   
   I've noticed this naming issue. But I don't know why `ExtensionAPI` didn't get a name like `EChartsAPI`.
   
   > And I'm not sure about the idea of providing same APIs in `export/api` and `export/extensionHelper`.
   
   It seems `export/api` is not public for users since it isn't in the final distributions. But `echarts/core` imports some parts from
   it. I think these APIs and types are more often to be used for extension developers, so extract them to the `extensionHelper`. It may look more intuitive from the naming.
   
   I don't have a great idea about this design. It may need further discussion.



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