Files
azuredatastudio/samples/sqlservices/README.md
Benjin Dubishar d9b5d71148 Adding Chart component (#24357)
* added doughnut chart component

* Changing chart to doughnutChart

* reverting to genreic chart component

* adding more chart supoort

* fix minor errors

* resolve some PR comments

* native chartjs, keyboard navigation and chart options

* fix build errors

* fix chart.js/auto error

* resolve PR comments

* modify chartdataset API

* Refactoring (#24327)

* working - displaying chart data with convert

* working - introduced typed properties

* working, added BarChartConfiguration to type param

* removed ChartProperties type param

* Adding doughnut support

* Correcting number vs. point issue

* including the right changes this time

* commenting out no-longer-used labels prop

* remove hardcoded canvasID, enabled Scatterplot config

* Moved graph testing to sample extension

* Reorganizing types; adding test back to assessment dialog

* Adding example for bubble chart

* Polar area working

* cleanup

* adding draw when options isn't set

* Moving chart example configs to other file

* some cleanup

* added some docstrings

* add multiple datasets to test scatter plot

* update scatter plot example in sample

* Adding height/width support

* swapping to `as` cast

* title working

* Settling chart title and legend display

* Adding comments

* updating data working

* Updating samples

* Typo in comment

* Reverting changes made for development

* Elaborating on color in docstrings

* Separating Data and Options in component payloads

* Removing chartId as an exposed property

* Changing chartType property to TChartType

* Fleshing out types file comments

* fixing scoping of chart component properties; renaming chart canvas ID prop

* correct internal chart options typing

* removing commented-out code

* removing unused ChartClickEvent type until data selection eventing is implemented

* renaming function

* deleted commented-out code

* Adding options setters that went missing after splitting Config to Data + Options

* adding type predicates for data conversion

* Adding back type setting (dropped when chart type conversion moved)

* Narrowing type for 'type'

* Fixing typos in docstring

---------

Co-authored-by: Deepak Saini <deepaksaini@microsoft.com>
Co-authored-by: Charles Gagnon <chgagnon@microsoft.com>
Co-authored-by: Aasim Khan <aaskhan@microsoft.com>
Co-authored-by: Deepak Saini <deepak.saini1996@gmail.com>
2023-09-13 20:11:09 -07:00

2.1 KiB

This is a sample extension that will show some basic model-backed UI scenarios and how to contribute feature providers(e.g. Connection, Object Explorer) in ADS. Note: only implement the providers this way if your data service has native JavaScript SDK available, otherwise use data protocol client, please refer to [SQL Tools Service] (https://github.com/microsoft/sqltoolsservice) or PG Tools Service as examples.

Run the following commands to produce an extension installation package

  • yarn install - to install the dependencies
  • yarn build - to build the code
  • vsce package - to produce an extension installation package; if not installed, run npm install --global @vscode/vsce first.

Launch ADS Dev instance with this extension

  • yarn install - to install dependencies
  • yarn build - to build the code
  • Launch VSCode and open the azuredatastudio's code folder, run the 'Launch azuredatastudio' debug option (to work around the issue. The next step won't work without doing this first)
  • Launch VSCode and open this folder, run the 'Debug in enlistment' target. To debug, install the sqlops-debug extension in VS Code.
  • Once ADS launches, you should be able to run the sqlservices commands, for example: sqlservices.openDialog.

Consuming azdata typing changes during development

If writing samples for new component model UI components that aren't yet checked into main, change the URL specified in sqlservices\tasks\buildtasks.js's copytypings task to point to the branch with the azdata.proposed.d.ts changes. Because this task pulls the azdata.proposed.d.ts type from this URL, your changes must be pushed to your branch before this will work. It does not use the local files.

After running yarn build, you should see your updated typings in sqlservices\typings\azdata.proposed.d.ts.

Important

Do not check in changes to this URL to main. This is for development only; revert these changes before they are sent out in a PR.