This commit is contained in:
richbrun 2017-02-01 13:04:13 -08:00
Родитель c2235ea830
Коммит 371ccd3ae0
2 изменённых файлов: 26 добавлений и 20 удалений

Просмотреть файл

@ -1,10 +1,10 @@
# Contributing to the Bing Maps V8 TypeScript Definitions
# Contributing to the Bing Maps V8 TypeScript Definitions #
## Code of Conduct
## Code of Conduct ##
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
## How to contribute
## How to contribute ##
There are a couple of ways you can contribute to this repo:
* **Ideas, feature requests and bugs**: We are open to all ideas and we want to get rid of bugs! Use the [Issues section](https://github.com/Microsoft/Bing-Maps-V8-TypeScript-Definitions/issues) to either report a new issue, provide your ideas or contribute to existing threads

Просмотреть файл

@ -4,19 +4,19 @@
[![npm](https://img.shields.io/badge/npm-1.0.13-red.svg)](https://www.npmjs.com/package/bingmaps)
[![license](https://img.shields.io/badge/license-MIT-yellow.svg)](LICENSE.md)
#Bing Maps V8 TypeScript Definitions
# Bing Maps V8 TypeScript Definitions #
These are the official TypeScript definitions for the [Bing Maps V8 Web Control](https://msdn.microsoft.com/en-US/library/mt712542.aspx). These can be used to provide intellisense and richer error catching functionality to your IDE.
![Bing Maps V8 Intellisense](images/V8Intellisense.gif "Bing Maps V8 Intellisense")
## How to get the definitions
## How to get the definitions ##
**Use the NuGet Package**
Using the [Bing Maps V8 TypeScript Definitions NuGet package](https://www.nuget.org/packages/Microsoft.BingMaps.V8.TypeScript/) will make it easy to both add the definitions to your project and to also keep them up to date.
If using Visual Studio, open the nuget package manager, select the Browse tab and search for "Bing Maps V8". This should reduce the list of results enough to fine the "Bing Maps V8 TypeScript Defintions" package. The owner of the package is bingmaps.
If using Visual Studio, open the nuget package manager, select the Browse tab and search for "Bing Maps V8". This should reduce the list of results enough to fine the "Bing Maps V8 TypeScript Definitions" package. The owner of the package is bingmaps.
Alternatively, if you are using the nuget commandline:
@ -34,9 +34,9 @@ npm install -g bingmaps
**Download definitions**
Simply press the download button for this repository. Unzip the downloaded file, and copy the the scripts folder into your project. Note that you will need to do this processagain from time to time if you want to have the most recent definitions. This should only be needed if you want to use newer features or if bugs in the definitions have been corrected.
Simply press the download button for this repository. Unzip the downloaded file, and copy the scripts folder into your project. Note that you will need to do this process again from time to time if you want to have the most recent definitions. This should only be needed if you want to use newer features or if bugs in the definitions have been corrected.
## Usage
## Usage ##
If using Visual Studio, you can add a reference to the core Bing Maps V8 functionality by adding the following to the top of your TypeScript file.
@ -67,7 +67,7 @@ or you can add a reference to the individual module definitions.
| [Traffic](https://msdn.microsoft.com/en-us/library/mt712860.aspx) | scripts/MicrosoftMaps/Modules/Traffic.d.ts |
| [Well Known Text](https://msdn.microsoft.com/en-us/library/mt712880.aspx) | scripts/MicrosoftMaps/Modules/WellKnownText.d.ts |
## Screenshots
## Screenshots ##
The following shows the intellisense for events. Notice how a list of the supported events are displayed, thus saving you from having to go back to documentation to verify the correct event name. Also notice how the structure of the event argument is known and you can easily access its properties.
@ -77,20 +77,12 @@ The following shows the intellisense for adding modules. A list of the supported
![Bing Maps V8 Load Module Intellisense](images/V8LoadModuleIntellisense.gif "Bing Maps V8 Load Module Intellisense")
## Additional Resources
## Q & A ##
* [Bing Maps V8 Interactive Code Samples](http://www.bing.com/api/maps/sdk/mapcontrol/isdk)
* [Bing Maps V8 MSDN Documentation](https://msdn.microsoft.com/en-us/library/mt712542.aspx)
* [Bing Maps Blog](http://blogs.bing.com/maps)
* [Bing Maps forums](https://social.msdn.microsoft.com/Forums/en-US/home?forum=bingmapsajax&filter=alltypes&sort=lastpostdesc)
* [Bing Maps for Enterpise site](https://www.microsoft.com/maps/)
## Q & A
- **Q: When will new Bing Maps features be added to these defintions.**
- **Q: When will new Bing Maps features be added to these definitions.**
- **A:** New features will be added to the definitions when they have graduated out of the experimental branch and into the main release branch of V8. This will often be done in parallel with MSDN documentation updates. A list of new features can be found in the release notes [here](https://msdn.microsoft.com/en-US/library/mt770019.aspx).
## Contributing
## Contributing ##
We welcome contributions. Feel free to file issues and pull requests on the repo and we'll address them as we can. Learn more about how you can help on our [Contribution Rules & Guidelines](CONTRIBUTING.md).
@ -99,3 +91,17 @@ You can reach out to us anytime with questions and suggestions using our communi
* [StackOverflow](http://stackoverflow.com/questions/tagged/bing-maps)
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information, see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
## License ##
MIT
See [License](LICENSE.md) for full license text.
## Additional Resources ##
* [Bing Maps V8 Interactive Code Samples](http://www.bing.com/api/maps/sdk/mapcontrol/isdk)
* [Bing Maps V8 MSDN Documentation](https://msdn.microsoft.com/en-us/library/mt712542.aspx)
* [Bing Maps Blog](http://blogs.bing.com/maps)
* [Bing Maps forums](https://social.msdn.microsoft.com/Forums/en-US/home?forum=bingmapsajax&filter=alltypes&sort=lastpostdesc)
* [Bing Maps for Enterprise site](https://www.microsoft.com/maps/)