TypeScriptの人気が高まるにつれ、これを実現する必要があると思います。 他の多くのjsパッケージには、独自の（公式の）タイピングが含まれ始めています。 DefinitelyTypedコミュニティに任せるのでは

これは私たちが検討していることです。 APIダンプから自動生成するノードスクリプトを作成できるはずです。

+1👍私からも。 DefinitelyTypedリポジトリは古く、Highcharts v4.2.x以降、散発的および偶発的なプロパティのみが更新されました。 しかし、Highcartsの

したがって、DefinitelyTypedリポジトリを更新するか、より便利に、Highchartsにバンドルする方がはるかに優れたソリューションになります。

自動生成することは素晴らしいオプションのように聞こえますが、それでも.d.tsファイルのテストを作成する部分で手作業が必要になる可能性がありますか？ また、自動生成することもできます。

DefinitelyTypedリポジトリを現在のリリースに更新する作業をしたいと思います。手動ファイルをそこに含めたい場合は、 https：//github.com/highcharts/highchartsでPRを行い

/ cc @ ry8806 @TorsteinHonsi

^ Highchartsv5.0.10を

公式のTypeScript型定義を持っていることを高く評価します。 チャート設定を入力するときに大いに役立ちます。

ここでも、タイプ定義が現実の背後にあるメジャーバージョンになっています。 ：/

このライブラリの複雑さを考えると、最良の解決策は、 @ TorsteinHonsiが参照した「APIダンプ」からtype- defを生成することだと思います。 ただし、そのリンクは壊れているようです。 新しいものはありますか？ 私はジェネレーターを書くことに積極的に取り組んでいきます。

ただし、そのリンクは壊れているようです。 新しいものはありますか？

はい、新しいものはhttps://api.highcharts.com/highcharts/tree.jsonから入手でき

@cvasseng参考までに。

@TorsteinHonsiありがとうこれを見てみましょう。 「jsdoc」の特定のフレーバー（Google Closure、JSDoc 3？）を使用していますか？JSONダンプは、参照用に確認できるこのコードベースのどこかで発生しますか？ 私が尋ねる理由は、動作する可能性のある既存のJSDocからTSDefへのコンバーターが存在するためです...

JSDoc 3を使用していますが、宣言型オプションの構造を記述できるように大幅に拡張されています。

@TorsteinHonsi JSONを見て、いくつか質問があります...この形式のスキーマドキュメントを持っていない可能性がありますか？ これは私が集めたものです。 Highcharts.setOptions()とHighcharts.chart()渡されるオプションをどのように指定しますか（たとえば）？ クラスと名前空間のAPIダンプもありますか？

@cvasseng

こんにちは@aaronbeall 、

Highcharts.setOptions()のオプションとシリーズはどちらも、それを使用するスキーマ自体の外部では特殊なケースとして処理されますが、少なくともglobalとlangを次のように変更する必要があります。メインオプション構造の外側。

ちなみに、古いダンプ形式はhttps://api.highcharts.com/dump.jsonで入手できましたが、 。 option /dump.json。

@cvassengに感謝します。 私はこれをいじり始めています...たくさんのデータがあります、私はそれをすべて理解するためだけに私の仕事を切り取っています。 :) boost.seriesThresholdなど、一部のフィールドにはタイプがなく、タイプを推測するデフォルトがないことに気付きましたが、タイプはドキュメントに表示されます。 これらは特別な場合として扱われますか、それとも何かが足りませんか？ また、名前空間/クラスのAPIスキーマはありますか、それとも個別に処理されますか？ 宣言型モデルはそれらを時代遅れにすることを意図していますか？

（もっと質問がありますが、これについて話し合うのに良い場所はありますか？Gitter？ここでは元気ですが、一部の人にとってはかなりのノイズが発生している可能性があります。）

boost.seriesThresholdのタイプは、実際にはtree.json （およびライブドキュメント）では間違っているように見えます。文字列ではなく数値であると想定されています。 それが生成された実際のドックレットを見ると、タイプが欠落しています。 これは、タイプが欠落している他の場所にも当てはまる可能性があります。 ジェネレーションパスにテストとチェックを追加して、ドックレットが変更されたときにこれらが自動的に検出されるように取り組んでいます。

名前空間/クラスのスキーマはありませんが、それらはバニラJSDoc 3によって処理されるため、既存のプラグインを追加して、それらのタイプスクリプト定義を自動的に生成できる場合があります。 その部分のセットアップはここで見つけることができます： https ：

そして、ここでこれを議論することはうまくいきます。 :)そうすれば、他の人もそれに従うことができるように、私たちはそれのための中央の公共の場所を持っています。

役に立つ場合は、これはタイプを持っていないように見えるすべてのフィールド（highcharts / tree.json内）のtypeプロパティまたはdefaultプロパティなので、 any割り当てられます。 それらのタイプのパッチファイルを書くことができますか、それとももっと良い方法がありますか？

トップレベルのJSONとmapNavigation.buttonsも空白のキーがあります。

私は今日これについていくらかの進歩を遂げました、あなたは現在ここで何ます。 この高品質を実現するには、まだ多くの作業が残っています。 明日はリポジトリにプッシュします。 大まかに言って、私が遭遇したいくつかの問題：

• 出力を整理する方法がわからない。 現在、559個のシンボルがあり、 Highcharts.OptionsやSeriesような重要なものから、 PlotOptionsBbTopLineような非常に特定の小さなオブジェクトまでが含まれています。 名前の競合を回避するために、フルネームをPascalCaseに変換します（例： plotOptions.bb.topLine 。 これをより良くする方法をまだ理解しようとしています。 現在の@types/highchartsと比較するのは少し難しいですが、多くの場合、そこには何かが存在しません。
• highcharts / highstocks / highmapsの関係を理解し​​ているかどうかはわかりません。 （私はHighchartsのみを個人的に使用しました。）APIダンプには、すべての製品のすべてのデータが含まれていますか？ どのように分割する必要がありますか？ プロジェクトで実際にhighstockとhighmapsを使用する方法をよりよく理解する必要があります...
• オブジェクトが相互に拡張する方法は完全に理にかなっていますが、それを適切なタイプに変換する方法を理解するのに苦労しています。 現時点では、 extendsが互換性のない拡張機能について多くのエラーを引き起こしていたため、オブジェクトは&交差型を使用してマージされています。 現在、 excludesの処理はありません。 Omit型で遊び始めましたが、型に存在しない省略されたフィールドについて多くのエラーが発生しました。 これは、オブジェクトプロパティが親から間接的に継承する場合があるため、実際には省略すべきフィールドがないためだと思います。親オブジェクトのプロパティにはあります。 plotOptions.mfi.paramsはこの例であり、 index除外しますが、 indexプロパティまたはextends持つオブジェクトはありませんが、親plotOptions.mfiは、子plotOptions.sma.paramsプロパティを持つplotOptions.smaを拡張し、 indexは、親でplotOptions.mfi.paramsとマージされます。 ええ、まだこれに対処する方法をうなずきます。 :)完全にマージされたツリーを評価し、そこからタイプを計算する必要があるようです...
• 多くの一般的なArray 、 Object 、およびFunctionタイプ...おそらくすべて説明で十分に文書化されていますが、タイプでは表現されていないようです。 たぶん、型データのいくつかの賢明なパッチがこれを修正するでしょう。 私のお気に入りはArray.<Array.<Mixed>> -それがまだ何であるかわかりません。 :)

他のいくつかの特定のもの：

• Color 、 CSSObject 、およびMixedタイプとは何ですか？ Colorはフォーマットされたstring 、 CSSObjectは標準スタイルのオブジェクトですか、それとも何か特別なものですか？
• series.bellcurve.dataとseries.histogram.dataどちらも拡張され、循環参照を作成します。 これは単なるタイプミスだと思います。おそらく他の何かを拡張するためのものですか？

また、 https：//api.highcharts.com/highstock/plotOptions.bb.topLine.styles.lineColorなど、不足しているタイプの一部はAPIで不足していません。 私の記憶が正しければ、 api-docsジェネレーターでタイプ推測を行いますが、これをhighcharts.jsdoc.jsスクリプトに移動して、tree.jsonの一部にすることができます。

@cvasseng公式のTypeScript定義のステータスはどうなっていますか？

これで

私が正しく覚えていれば、 api-docsジェネレーターでタイプ推測を行います

api-docsジェネレーターがどのように機能するかを知りたいと思います。 これは、APIダンプを理解するのに役立ちます。 どう対処したらいいのかわからないものを見つけています。 たとえば、 series.bullet.data.targetOptionsはseries.bullet.targetOptions series.bullet.data.targetOptions拡張しますが、 series.bullet.targetOptions定義は存在しません...ただし、プロパティはドキュメントに問題なく表示されます。 私はので、それはだと思うseries.bullet拡張plotOptions.bullet持っているplotOptions.bullet.targetOptionsので、 series.bullet.targetOptionsに解決plotOptions.bullet.targetOptions ？

編集：今夜の少しの進歩、デフォルト値の私の真実のチェックはすべてのリテラルfalse値を破棄し、それを修正し、さらに多くのものがブール値として推測されました。 ただし、一部の場所でブール値が正しいタイプであるかどうかはわかりません。 また、 valuesでリテラル型を確認します（その情報は素晴らしいです！）。 とにかく、不足しているタイプのダンプが更新されます。

ツリーがオブジェクトをどのように拡張するかを考えた後、いくつかの進歩を遂げました。

• 指定されたパスでマージされるすべての定義を解決する方法を思いついた。 （これは私の脳を伸ばしました...私はドキュメントジェネレータがこのようなことをすることを想像しますか？）
• 次に、ツリーの他の部分からマージされた他の定義をシャドウするパスで冗長な定義を削減します。これにより、約100の冗長オブジェクト定義と数百の冗長プロパティが削除されます。 （これらの「冗長な」定義の多くは、説明やデフォルト値などのドキュメントの追加を提供するために存在しているように見えましたが、タイプ定義の助けにはなりませんでした...正しく聞こえますか？）
• その後、縮小されたツリーのいくつかのdefだけが、推測できない型が実際に欠落していました。これをここでパッチします（これらの変更は、おそらくjsdoc自体で適切です）。 推測された型が常に正しいことを検証していませんが、残っているものはすべて推測できます（最新の「欠落している型」ダンプを参照）。 object 、 array 、 functionなどのあいまいなタイプの問題もまだあります。
• これは、 TSタイプのdefツリーがどのように変更されるこの生成された出力が得られ、有望に見え始めています。

次は何ですか

• 除外されたフィールドを処理します。これには、 Omit<>を使用し、 excludesを持つすべてのオブジェクトに明示的なextendsを追加するためのパスを作成する戦略があると思います（最初の箇条書き）、およびすべてのオプションのプロパティを持つインターフェイスを使用するように元に戻します。 プロパティがすべてオプションであることが確実である限り、これは機能すると思いますか？ 必要な物件はありますか？
• その他の詳細：タイプの改善、クリーンアップ、およびテスト
• 休み明けにこれを取り戻します。 これが正しい方向に進んでいるかどうかさえもあなたたちが思うなら、どんなフィードバックも大好きです。

質問

• tooltipValueFormatドックレットの"memberof": "yaxis"はどういう意味ですか？
• context値の1つはPlotLineOrBandが、クラスのドキュメントには表示されません。これはSeriesサブクラスですか？
• plotOptions.series.statesはドックレットタイプ名"plotOptions.series.states" -それは何か特別なことを意味しますか？

@aaronbeall何か進歩はありますか？ また、highchartsの型生成についても少し詳しく説明しました。

大きな欠陥の1つは、生成されたtree.json 、highcharts名前空間の静的メソッドのように、highchartsのすべての型が含まれていないことです。 有効なシンボルプルーニングの後に703個のシンボルがあります。 しかしその後、tree.json内の出力シンボルは約100になります。それはそれらの多くが無視されます。

@ scott-ho新年にHighchartsを使ってプロジェクトをやめたので少し経ちましたが、今はまた戻ってきて、すぐにこのプロジェクトに戻ります。

前回の投稿から、 typeをinterfaceに変換し、 extends代わりに& extendsを使用するというルートをたどりました（これは、 tree.jsonを適切にサポートするための私の戦略excludesの使用）、および問題が発生しました：TSは、少なくとも共有しないオブジェクトタイプであるフィールド名を共有する別のインターフェイスを拡張することをインターフェイスに許可しません1物件。 これが抽象的な例です。 私が遭遇したこの正確な例を忘れましたが、 tree.jsonがオブジェクトを自由に拡張し（場合によっては拡張チェーンが5を超えた）、任意の時点でフィールドを自由に除外する方法のために、たくさんありました。 これにより、 &交差型を使用する以前のアプローチが最適なルートである可能性があると思いました。 基本的に、「除外」された一部のプロパティは、実際には型ヒントで除外されて表示されません（現在のノードから省略できないツリーの上位に拡張されたものからマージされるため）が、私はできませんそれを行うためのより良い方法を考えてください。 ドキュメントはプロパティを単一のポイントからレンダリングするため、この問題を回避しますが、構造的には、 extendsを捨てて、ほとんど重複する型定義を大量に作成しない限り、そのように型を記述することはできません。

有効なシンボルプルーニングの後に703個のシンボルがあります。 しかしその後、tree.json内の出力シンボルは約100になります。それはそれらの多くが無視されます。

どのような剪定方法を参照していますか？ これは対処するのが最も難しい部分です...

はい、クラス/名前空間がtree.json記述されていないことにも気づきました（これは基本的に私が理解しているように宣言型のinitオプションを記述しています）が、 @ cvassengはそれらがバニラjsdoc3であると言ったので、標準を使用できることを願っていますそのためのコンバーター。

pruningはこの行から参照されます。

tree.jsonすべてのデータ収集は、 publishメソッド内にあります。

その中にjsdocapiの誤用があるかもしれないと思います。

jsdocからの元の出力に基づいて、新しいバージョンのtree.jsonを生成するためのより良い方法を見つけることができます。

今日、私はtree.json何を表しているのかを調べるためにしばらく時間を費やしました。 それから私はついにtree.jsonがチャートオプションのタイプのみをホストしていることを理解しました。 https://api.highcharts.com/highcharts/を参照して

タイプの収集と生成のロジックはここに書かれています-https：//github.com/highcharts/highcharts/blob/master/tools/jsdoc/plugins/highcharts.jsdoc.js。

自分で型のフルバージョンを生成し、 https：//github.com/englercj/tsd-jsdocのようなことをする必要があるかもしれません

このためのETAはありますか？ DefinitelyTypedの定義はかなりひどいものです。

必要な不足している機能についてTypeScriptチームに相談することを検討しましたか？ 彼らはHighchartsのサイズのプロジェクトのニーズに耳を傾け、リリースサイクルはかなり速いと確信しています。

@aaronbeallマップされたタイプを見たことがありますか？

これがあなたの例の修正へのリンクです

@cvasseng @TorsteinHonsi

必要な不足している機能についてTypeScriptチームに相談することを検討しましたか？

@JannesMeyer残念ながらOmit<>機能して物事を区別する方法です...しかし、私にとっての課題は、Highchartsデータ構造が使用可能で定義されている方法をどのように理解するかです。 、完全な人間工学的タイプの定義。 定義は最小限に定義する必要があるようです（つまり、あちこちの類似したオブジェクトで同じプロパティを再定義しないでください）が、何も見逃すことはありません。 Highchartsが特定のコンテキストで実際に使用しないオプションを型補完に表示することは、そこにあるはありobjectまたはanyタイプになるドキュメントスキーマが不足しているという問題もあります...誰かがタイプを書き留める必要がある場合、タイプ生成ではそれを行うことができません。

うん、それは理にかなっている。 Highchartsチームは、現在よりも少しだけTypeScriptを採用する必要があるようです。 jsdocからドキュメントを生成するのではなく、型定義からドキュメントを生成することも可能でしょうか？

@ JannesMeyer ＃8307は、フルタイプのHighchartsを生成する途中です。 レビューが必要です。 ドキュメントの改善がマージされると、jsdoc表記に基づいて完全なタイプを自動生成するために別のPRが発行されます。

私はこの投稿をフォローしてきましたが、宣言ファイルが利用できると非常に役立ちます。
私はReact / TypescriptプロジェクトにDefenitelyTypedを使用しています。 しかし、アクセシビリティに行き詰まりました。 アクセシビリティ部分がDefenitelyTypedで機能しないことに気づいていませんでした。 問題についてHighchartsサポートチームに連絡しましたが、まだ運がありません。
私たちのチームでは、Highcharts / Highmapsを多用しています。 したがって、私たちはそれに投資しました。 このプロジェクトの優先順位について考えてみてください。

前もって感謝します！

この問題の優先度が高くなっていることをお知らせします。

Highchartsチーム（ @sophiebremerと@oysteinmoseng ）は実際に私とのデバッグセッションに参加し、Jsファイルを直接ロードすることでこの問題の解決を支援してくれました。 現時点で私をブロック解除するために彼らが提供してくれた時間と解決策に本当に感謝しています。 究極の解決策としてHighchartsを含むTS宣言ファイルを楽しみにしています。 :)

これを優先してくれた@sophiebremerに感謝します。 これは、Typescriptを使用しているプロジェクトに非常に役立ちます。

注：コメントを編集して、より良いコンテキストを提供し、Highchartsチームの人々にも感謝します。

私たちは、Angular / Typescriptを扱う大規模なフロントエンドチームでHighstockを集中的に使用しています。 タイプスクリプトの定義があるとすごいでしょう。DefinitelyTypedの定義が参照だと思いましたが、Highstockでは完全に時代遅れです。

このタイプスクリプトの定義は、私たちにとって本当に大きなニーズです。
どんなETAでも大歓迎です:)

現在、品質に取り組み、Highchartsのオプションツリーで生成されるインターフェイスの数を減らすようにしています。 この後、パブリックベータフェーズを開始します。

私たちのETAは、今のところベータ版の2018年第3四半期です。

@sophiebremerそれは素晴らしいニュースです！ DTSジェネレーターをお持ちですか、それとも既存の変換ツールを使用していますか？

カスタムのものを使用します。 下のdts-domを使用して、このプルリクエストhttps://github.com/highcharts/highcharts/pull/8307のアプローチを試しましたが、うまくいきませんでした。

これに関するニュースはありますか？ @types/highchartsはもう更新されていないようです。

現在も優先度の高い取り組みを行っております。 残念ながら、現在、宣言のプレビューを公開することはできません。 統合する必要がある、または導入する必要があるタイプがまだあります。 「highcharts.d.ts」は、200.000行を超える宣言とコメントを含む巨大なファイルになります。

@sophiebremerどのようにしてそのファイルを作成しますか？ 手動で？

@ scott-ho
宣言ファイルは自動的に生成されますが、ソースコード内のドックレットの修正と更新は手動のプロセスです。

皆さんこんにちは！ Highchartsの宣言のプレビューを個人リポジトリに公開しました。 npm i https://github.com/sophiebremer/highcharts-declarations-alpha.gitテストするか、 https：//github.com/sophiebremer/highcharts-declarations-alpha/blob/master/highcharts.d.tsから宣言をダウンロードして、 ./node_modules/highcharts/直接配置できます。

既知の問題点：

• options.seriesプロパティのタイプピン留めが機能していません。 現在の回避策は、オブジェクトを{ data: [0, 1, 2]} as Highcharts.SeriesLineOptionsようなシリーズタイプにキャストすることです。
• スタイルオプションはCSSObjectタイプのどこにでもあるわけではありません

選択などのChartEventsOptions関数は、イベント関数パラメーターを取り込んでいないようです

私が見つけた他のいくつかの問題

• エクスポート中のofflinexportingモジュールをインポートできません。 デフォルトのファクトリをエクスポートしてデフォルトのインポートとして使用するには、export = factoryを変更する必要がありました

• 注釈モジュールがありません

• PlotSeriesEventsOptionsクリックはクリックとして変更する必要がありますか？:( e：PointerEventObject）=>ブール値;

フィードバックありがとうございます、 @ muperi ！
2番目の投稿に関するコメント：

• 通常のモジュールはデフォルトのエクスポートを行いません。 ES6の設定についてはtsconfigを確認してください。
• まだ宣言されているモジュールはごくわずかです。 もちろん、今後数か月でさらに追加する予定です。
• この問題を調査します。

選択などのChartEventsOptions関数は、イベント関数パラメーターを取り込んでいないようです

修正はhighcharts / highcharts＃9110の一部であり、 https：//github.com/highcharts/highcharts-declarations-betaの次のアップデートに含まれる予定

このリポジトリに宣言ファイルに関する問題をさらに追加してください： https ：

ありがとうございました。