Skip to content

Commit

Permalink
Rename “collaboration chart” to “chord chart”
Browse files Browse the repository at this point in the history
With the recent refactoring, the level of granularity in chart type
names became inconsistent. “Chord chart” is a more general term for the
kind of chart that we use to visualize collaboration.
  • Loading branch information
pluehne authored and larsxschneider committed Jan 22, 2018
1 parent b0e0ab5 commit ae81086
Show file tree
Hide file tree
Showing 4 changed files with 9 additions and 9 deletions.
4 changes: 2 additions & 2 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,13 +28,13 @@ Charts generally have the following structure:
```

- `<h3>`: the title of the chart (required)
- `<canvas>`: used to configure regular charts; change the tag to `<table>` for tables and `<svg>` for collaboration charts
- `<canvas>`: used to configure regular charts; change the tag to `<table>` for tables and `<svg>` for chord charts
- `data-url`: the URL to the `.tsv` file that shall be rendered by the chart (generated by the [updater](../updater/README.md))
- `data-type`: the chart type, supported types are:
- `history`: time series charts for tracking metrics over time
- `list`: horizontal bar charts for general numeric data
- `table`: tables directly rendered from the TSV source
- `collaboration`: chord diagrams used to visualize connections between entities
- `chord`: chord diagrams used to visualize connections between entities
- `data-config`: chart-type-specific configuration options (see [option list below](#configuration-options))
- `<div class="info-box">`: zero or more info boxes with descriptive texts

Expand Down
6 changes: 3 additions & 3 deletions docs/assets/js/charts.js
Original file line number Diff line number Diff line change
Expand Up @@ -723,7 +723,7 @@ function visualizeSingleOrg(orgs, matrix, orgID)
drawCoord(orgs, matrix);
}

function createCollaborationChart(canvas)
function createChordChart(canvas)
{
const url = $(canvas).data('url');
const quota = 50;
Expand Down Expand Up @@ -831,8 +831,8 @@ $(window).bind('load', function()
return createHistoryChart(canvas);
case 'list':
return createList(canvas);
case 'collaboration':
return createCollaborationChart(canvas);
case 'chord':
return createChordChart(canvas);
}
});

Expand Down
2 changes: 1 addition & 1 deletion docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ <h3>Collaboration Across Organizations</h3>
width="1000"
height="1000"
data-url="{{ site.dataURL }}/org-collaboration.tsv"
data-type="collaboration"
data-type="chord"
></svg>
<div class="info-box">
<p>
Expand Down
6 changes: 3 additions & 3 deletions docs/spec/charts.js
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
/* global createCollaborationChart, createHistoryChart, createList, createTable, createSpinner */
/* global createChordChart, createHistoryChart, createList, createTable, createSpinner */

describe('global charts.js', function()
{
describe('createCollaborationChart function', function()
describe('createChordChart function', function()
{
it('should exist', function()
{
expect(createCollaborationChart).toBeDefined();
expect(createChordChart).toBeDefined();
});
});
describe('createHistoryChart function', function()
Expand Down

0 comments on commit ae81086

Please sign in to comment.