DataBind Charts to Coda Data
DataBinding facilitates two-way interaction with data through UI controls. Using the CData ADO.NET Provider for Coda streamlines the process of binding Coda data to Windows Forms and Web controls within Visual Studio. In this article, we will demonstrate using wizards to establish a binding between Coda 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 Coda, follow the steps outlined below using the Data Source Configuration Wizard. Within the wizard, you'll have the option to choose the specific Coda entities you wish to bind to.
- 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.
- In the Data Source Configuration Wizard that appears, select Database -> Dataset.
- In the Choose Your Data Connection step, click New Connection.
In the Add Connection dialog, click Change to select the CData Coda Data Source.
Below is a typical connection string:
Profile=C:\profiles\Coda.apip;ProfileSettings='APIKey=your_api_token';
Start by setting the Profile connection property to the location of the Coda Profile on disk (e.g. C:\profiles\Coda.apip). Next, set the ProfileSettings connection property to the connection string for Coda (see below).
Coda API Profile Settings
Obtain your API token from your Coda account settings under the API Settings section.
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.
- Choose the database objects you want to work with. This example uses the AclMetadata 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 CanShare and the y-axis to CanShareWithWorkspace.
- In the Chart properties, click the button in the Series property to open the Series Collection Editor.
- 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 Coda data. Run the chart to display the current data.
Code Walk-through
DataBinding to Coda data requires only a few lines of code and can be completed in three easy steps.
- Connect to Coda.
- Create the APIDataAdapter to execute the query and create a DataSet to be filled with its results.
- DataBind the result set to the chart.
Below is the complete code:
APIConnection conn = new APIConnection("Profile=C:\profiles\Coda.apip;ProfileSettings='APIKey=your_api_token';");
APICommand comm = new APICommand("SELECT CanShare, CanShareWithWorkspace FROM AclMetadata WHERE DocId = 'AbCdEfGh'", conn);
APIDataAdapter da = new APIDataAdapter(comm);
DataSet dataset = new DataSet();
da.Fill(dataset);
chart1.DataSource = dataset;
chart1.Series[0].XValueMember = "CanShare";
chart1.Series[0].YValueMembers = "CanShareWithWorkspace";
// Insert code for additional chart formatting here.
chart1.DataBind();