Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 | /**
* @module DashboardIntegration
* @category Example - How to Integrate ChartUtils into Existing Dashboards
*
* @description
* **Example Pattern for Integrating ChartUtils into Dashboard Files**
*
* This file demonstrates the pattern for updating existing dashboard JavaScript
* files to use the new ChartUtils module for:
* - Responsive Chart.js configuration
* - Empty/loading/error states
* - Accessibility features
* - Performance optimization
*
* ## Integration Steps
*
* 1. **Add Loading State**: Show loading indicator before data fetch
* 2. **Handle Empty Data**: Display user-friendly empty state
* 3. **Handle Errors**: Show error state with retry option
* 4. **Use Responsive Options**: Apply ChartUtils.getResponsiveOptions()
* 5. **Add Keyboard Nav**: Enable keyboard navigation for charts
* 6. **Add Resize Handler**: Create debounced resize handler
*
* ## Before (Original Code)
*
* ```javascript
* function createChart(data) {
* const ctx = document.getElementById('myChart');
*
* new Chart(ctx, {
* type: 'bar',
* data: {
* labels: data.labels,
* datasets: [{
* label: 'My Dataset',
* data: data.values
* }]
* },
* options: {
* responsive: true,
* // ... basic options
* }
* });
* }
* ```
*
* ## After (With ChartUtils)
*
* ```javascript
* function createChart(data) {
* const ctx = document.getElementById('myChart');
*
* // Hide loading state
* ChartUtils.hideStateOverlays('myChart');
*
* // Handle empty data
* if (!data || data.values.length === 0) {
* ChartUtils.showEmptyState('myChart', 'No data available for selected period');
* return;
* }
*
* // Create chart with responsive options
* const chart = new Chart(ctx, {
* type: 'bar',
* data: {
* labels: data.labels,
* datasets: [{
* label: 'My Dataset',
* data: data.values,
* backgroundColor: ChartUtils.THEME_COLORS.cyan
* }]
* },
* options: ChartUtils.getResponsiveOptions('bar', {
* plugins: {
* tooltip: {
* callbacks: {
* label: (context) => {
* return `${context.dataset.label}: ${ChartUtils.formatNumber(context.parsed.y)}`;
* }
* }
* }
* }
* })
* });
*
* // Add keyboard navigation
* ChartUtils.addKeyboardNavigation(ctx, chart);
* }
*
* // Main initialization function
* async function initDashboard() {
* // Show loading state
* ChartUtils.showLoadingState('myChart');
*
* try {
* // Fetch data
* const data = await fetchData();
*
* // Create chart
* createChart(data);
*
* } catch (error) {
* // Show error state
* ChartUtils.showErrorState('myChart', error.message);
* }
* }
*
* // Add resize handler
* const charts = [];
* window.addEventListener('resize', ChartUtils.createResizeHandler(charts));
* ```
*
* @author Hack23 AB - Political Intelligence Team
* @license Apache-2.0
* @version 1.0.0
* @since 2026
*/
// =============================================================================
// EXAMPLE 1: Simple Bar Chart with Empty State Handling
// =============================================================================
function example1_SimpleBarChart() {
const containerId = 'example1Chart';
// Step 1: Show loading state
ChartUtils.showLoadingState(containerId);
// Step 2: Fetch data (simulated)
setTimeout(() => {
const data = {
labels: ['S', 'M', 'SD', 'C', 'V', 'KD', 'L', 'MP'],
values: [25, 20, 18, 12, 10, 7, 5, 3]
};
// Step 3: Hide loading state
ChartUtils.hideStateOverlays(containerId);
// Step 4: Handle empty data
if (!data || data.values.length === 0) {
ChartUtils.showEmptyState(containerId, 'No party data available');
return;
}
// Step 5: Create chart with responsive options
const ctx = document.getElementById(containerId);
const chart = new Chart(ctx, {
type: 'bar',
data: {
labels: data.labels,
datasets: [{
label: 'Party Votes (%)',
data: data.values,
backgroundColor: ChartUtils.THEME_COLORS.cyan
}]
},
options: ChartUtils.getResponsiveOptions('bar')
});
// Step 6: Add keyboard navigation
ChartUtils.addKeyboardNavigation(ctx, chart);
}, 1000);
}
// =============================================================================
// EXAMPLE 2: Line Chart with Error Handling
// =============================================================================
function example2_LineChartWithError() {
const containerId = 'example2Chart';
// Show loading state
ChartUtils.showLoadingState(containerId);
// Simulate data fetch with error
setTimeout(() => {
const hasError = Math.random() > 0.5; // 50% chance of error
if (hasError) {
// Show error state
ChartUtils.showErrorState(containerId, 'Failed to load data from CIA Platform');
return;
}
// Success: create chart
ChartUtils.hideStateOverlays(containerId);
const ctx = document.getElementById(containerId);
const chart = new Chart(ctx, {
type: 'line',
data: {
labels: ['2020', '2021', '2022', '2023', '2024', '2025', '2026'],
datasets: [{
label: 'Legislative Activity',
data: [120, 135, 150, 142, 158, 165, 170],
borderColor: ChartUtils.THEME_COLORS.magenta,
backgroundColor: 'rgba(255, 0, 110, 0.1)',
tension: 0.4
}]
},
options: ChartUtils.getResponsiveOptions('line')
});
ChartUtils.addKeyboardNavigation(ctx, chart);
}, 1500);
}
// =============================================================================
// EXAMPLE 3: Multiple Charts with Resize Handler
// =============================================================================
function example3_MultipleChartsWithResize() {
const charts = [];
// Create multiple charts
['chart1', 'chart2', 'chart3'].forEach((id, index) => {
ChartUtils.showLoadingState(id);
setTimeout(() => {
ChartUtils.hideStateOverlays(id);
const ctx = document.getElementById(id);
const chart = new Chart(ctx, {
type: index === 0 ? 'bar' : index === 1 ? 'line' : 'doughnut',
data: {
labels: ['A', 'B', 'C', 'D'],
datasets: [{
label: `Dataset ${index + 1}`,
data: [10, 20, 30, 40].map(v => v * (index + 1)),
backgroundColor: [
ChartUtils.THEME_COLORS.cyan,
ChartUtils.THEME_COLORS.magenta,
ChartUtils.THEME_COLORS.yellow,
ChartUtils.THEME_COLORS.lightText
]
}]
},
options: ChartUtils.getResponsiveOptions(
index === 0 ? 'bar' : index === 1 ? 'line' : 'pie'
)
});
charts.push(chart);
ChartUtils.addKeyboardNavigation(ctx, chart);
}, 1000 + (index * 500));
});
// Add resize handler for all charts
window.addEventListener('resize', ChartUtils.createResizeHandler(charts));
}
// =============================================================================
// EXAMPLE 4: D3.js Heatmap with ChartUtils Colors
// =============================================================================
function example4_D3HeatmapWithThemeColors() {
const containerId = 'example4Heatmap';
ChartUtils.showLoadingState(containerId);
setTimeout(() => {
ChartUtils.hideStateOverlays(containerId);
const container = d3.select(`#${containerId}`);
const width = container.node().getBoundingClientRect().width;
const height = 400;
// Use ChartUtils theme colors for D3.js
const colorScale = d3.scaleSequential()
.domain([0, 100])
.interpolator(d3.interpolateRgb(
ChartUtils.THEME_COLORS.cyan,
ChartUtils.THEME_COLORS.magenta
));
const svg = container.append('svg')
.attr('width', width)
.attr('height', height)
.attr('role', 'img')
.attr('aria-label', 'Risk assessment heatmap')
.style('background', ChartUtils.THEME_COLORS.darkBg);
// Create sample heatmap cells
const data = d3.range(100).map(i => ({
x: i % 10,
y: Math.floor(i / 10),
value: Math.random() * 100
}));
const cellSize = Math.min(width / 10, height / 10);
svg.selectAll('rect')
.data(data)
.enter().append('rect')
.attr('x', d => d.x * cellSize)
.attr('y', d => d.y * cellSize)
.attr('width', cellSize - 2)
.attr('height', cellSize - 2)
.attr('fill', d => colorScale(d.value))
.attr('stroke', ChartUtils.THEME_COLORS.darkBg)
.attr('stroke-width', 2)
.attr('tabindex', 0) // Keyboard accessibility
.on('focus', function(event, d) {
// Announce to screen readers
ChartUtils.announceDataPoint({
data: {
labels: [`Cell ${d.x},${d.y}`],
datasets: [{ data: [d.value] }]
}
}, 0);
});
}, 1000);
}
// =============================================================================
// EXAMPLE 5: Complete Dashboard Integration Pattern
// =============================================================================
/**
* Complete dashboard integration example
* This function demonstrates the full pattern but does not auto-execute
* Call runCompleteDashboardExample() to execute
*/
function runCompleteDashboardExample() {
'use strict';
// Configuration
const CONFIG = {
dataUrl: 'cia-data/example-data.csv',
chartContainerIds: [
'effectivenessChart',
'comparisonChart',
'momentumChart'
]
};
// Store chart instances
let chartInstances = [];
/**
* Initialize dashboard
*/
async function initDashboard() {
// Show loading states for all charts
CONFIG.chartContainerIds.forEach(id => {
ChartUtils.showLoadingState(id);
});
try {
// Fetch data
const data = await fetchData();
// Create charts
createEffectivenessChart(data);
createComparisonChart(data);
createMomentumChart(data);
// Setup resize handler
window.addEventListener('resize',
ChartUtils.createResizeHandler(chartInstances)
);
} catch (error) {
console.error('Dashboard initialization error:', error);
CONFIG.chartContainerIds.forEach(id => {
ChartUtils.showErrorState(id, error.message);
});
}
}
/**
* Fetch data from CIA Platform
*/
async function fetchData() {
const response = await fetch(CONFIG.dataUrl);
if (!response.ok) {
throw new Error(`HTTP ${response.status}: Failed to fetch data`);
}
return await response.json();
}
/**
* Create effectiveness chart
*/
function createEffectivenessChart(data) {
const containerId = 'effectivenessChart';
ChartUtils.hideStateOverlays(containerId);
if (!data || data.effectiveness.length === 0) {
ChartUtils.showEmptyState(containerId, 'No effectiveness data available');
return;
}
const ctx = document.getElementById(containerId);
const chart = new Chart(ctx, {
type: 'line',
data: {
labels: data.effectiveness.map(d => d.year),
datasets: [{
label: 'Effectiveness Score',
data: data.effectiveness.map(d => d.score),
borderColor: ChartUtils.THEME_COLORS.cyan,
backgroundColor: 'rgba(0, 217, 255, 0.1)',
tension: 0.4
}]
},
options: ChartUtils.getResponsiveOptions('line', {
plugins: {
tooltip: {
callbacks: {
label: (context) => {
return `Score: ${ChartUtils.formatNumber(context.parsed.y, 1)}`;
}
}
}
}
})
});
chartInstances.push(chart);
ChartUtils.addKeyboardNavigation(ctx, chart);
}
/**
* Create comparison chart
*/
function createComparisonChart(data) {
const containerId = 'comparisonChart';
ChartUtils.hideStateOverlays(containerId);
if (!data || data.comparison.length === 0) {
ChartUtils.showEmptyState(containerId, 'No comparison data available');
return;
}
const ctx = document.getElementById(containerId);
const chart = new Chart(ctx, {
type: 'bar',
data: {
labels: data.comparison.map(d => d.party),
datasets: [{
label: 'Performance',
data: data.comparison.map(d => d.performance),
backgroundColor: ChartUtils.THEME_COLORS.parties['S'] // Example: use party colors
}]
},
options: ChartUtils.getResponsiveOptions('bar')
});
chartInstances.push(chart);
ChartUtils.addKeyboardNavigation(ctx, chart);
}
/**
* Create momentum chart
*/
function createMomentumChart(data) {
const containerId = 'momentumChart';
ChartUtils.hideStateOverlays(containerId);
if (!data || data.momentum.length === 0) {
ChartUtils.showEmptyState(containerId, 'No momentum data available');
return;
}
const ctx = document.getElementById(containerId);
const chart = new Chart(ctx, {
type: 'doughnut',
data: {
labels: data.momentum.map(d => d.party),
datasets: [{
label: 'Momentum',
data: data.momentum.map(d => d.score),
backgroundColor: [
ChartUtils.THEME_COLORS.cyan,
ChartUtils.THEME_COLORS.magenta,
ChartUtils.THEME_COLORS.yellow
]
}]
},
options: ChartUtils.getResponsiveOptions('doughnut')
});
chartInstances.push(chart);
ChartUtils.addKeyboardNavigation(ctx, chart);
}
// Initialize on DOM ready
if (document.readyState === 'loading') {
document.addEventListener('DOMContentLoaded', initDashboard);
} else {
initDashboard();
}
}
// =============================================================================
// EXPORT FOR DOCUMENTATION
// =============================================================================
if (typeof module !== 'undefined' && module.exports) {
module.exports = {
example1_SimpleBarChart,
example2_LineChartWithError,
example3_MultipleChartsWithResize,
example4_D3HeatmapWithThemeColors,
runCompleteDashboardExample
};
}
// =============================================================================
// AUTO-EXECUTION (Browser Only)
// =============================================================================
/**
* Auto-execute examples only in browser context
* Guards against execution in Node.js/test environments
*/
if (typeof window !== 'undefined' && typeof document !== 'undefined') {
// Only run if this script is explicitly included in a page that wants the examples
// Check for a data attribute or specific element to opt-in
if (document.currentScript && document.currentScript.dataset.autorun === 'true') {
runCompleteDashboardExample();
}
}
|