DataBind Charts to CircleCI Data

DataBinding facilitates two-way interaction with data through UI controls. Using the CData ADO.NET Provider for CircleCI streamlines the process of binding CircleCI data to Windows Forms and Web controls within Visual Studio. In this article, we will demonstrate using wizards to establish a binding between CircleCI data and a chart that dynamically updates. Additionally, the code walk-through section will guide you through the creation of a chart using just 10 lines of code.

Binding Data to a Chart

DataBinding to a Chart consists of three steps: Instantiate the control, configure the data source, and databind.

Configure the Connection and Select Database Objects

To create a chart control and establish a connection to CircleCI, follow the steps outlined below using the Data Source Configuration Wizard. Within the wizard, you'll have the option to choose the specific CircleCI entities you wish to bind to.

1. In a Windows Forms project, drag and drop a Chart control from the toolbox to the form. In the Data section of the Chart properties, select DataSource and then select Add Project Data Source from the menu.
2. In the Data Source Configuration Wizard that appears, select Database -> Dataset.
3. In the Choose Your Data Connection step, click New Connection.

4. In the Add Connection dialog, click Change to select the CData CircleCI Data Source.

   Below is a typical connection string:

   Profile=C:\profiles\CircleCI.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_personal_api_token';

   Using API Key Authentication

   CircleCI uses personal API tokens to authenticate API requests. To generate a personal API token, log in to your CircleCI account, navigate to User Settings > Personal API Tokens, and click Create New Token. Copy the token value immediately as it is only shown once.

   After setting the following connection properties, you are ready to connect:

   • AuthScheme: Set this to APIKey.
   • APIKey: Set this to your CircleCI personal API token.

   Example connection string:

   Profile=C:\profiles\CircleCI.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_personal_api_token';
   

   When you configure the connection, you may also want to set the Max Rows connection property. This will limit the number of rows returned, which is especially helpful for improving performance when designing reports and visualizations.

   
5. Choose the database objects you want to work with. This example uses the Artifacts table.

DataBind

After adding the data source and selecting database objects, you can bind the objects to the chart. This example assigns the x-axis to and the y-axis to .

1. In the Chart properties, click the button in the Series property to open the Series Collection Editor.
2. In the Series properties, select the columns you want for the x- and y-axes: Select columns from the menu in the XValueMember and YValueMember properties.

The chart is now databound to the CircleCI data. Run the chart to display the current data.

Code Walk-through

DataBinding to CircleCI data requires only a few lines of code and can be completed in three easy steps.

1. Connect to CircleCI.
2. Create the APIDataAdapter to execute the query and create a DataSet to be filled with its results.
3. DataBind the result set to the chart.

Below is the complete code:

APIConnection conn = new APIConnection("Profile=C:\profiles\CircleCI.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_personal_api_token';");
APICommand comm = new APICommand("SELECT ,  FROM Artifacts WHERE ProjectSlug = 'github/MyOrg/my-repo'", conn);
APIDataAdapter da = new APIDataAdapter(comm);
DataSet dataset = new DataSet();
da.Fill(dataset);

chart1.DataSource = dataset;  
chart1.Series[0].XValueMember = "";
chart1.Series[0].YValueMembers = "";
// Insert code for additional chart formatting here.
chart1.DataBind();