Skip to content

Commit 91a4759

Browse files
docs: add/update TOC for Documentation/Examples markdown files
1 parent 68566ea commit 91a4759

29 files changed

+797
-0
lines changed

Documentation/API/Charts.md

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,68 @@
11
# Charts API Documentation
22

3+
<!-- TOC START -->
4+
## Table of Contents
5+
- [Charts API Documentation](#charts-api-documentation)
6+
- [Table of Contents](#table-of-contents)
7+
- [LineChart](#linechart)
8+
- [Initialization](#initialization)
9+
- [Properties](#properties)
10+
- [Example Usage](#example-usage)
11+
- [Features](#features)
12+
- [BarChart](#barchart)
13+
- [Initialization](#initialization)
14+
- [Example Usage](#example-usage)
15+
- [Features](#features)
16+
- [PieChart](#piechart)
17+
- [Initialization](#initialization)
18+
- [Example Usage](#example-usage)
19+
- [Features](#features)
20+
- [ScatterChart](#scatterchart)
21+
- [Initialization](#initialization)
22+
- [Example Usage](#example-usage)
23+
- [Features](#features)
24+
- [AreaChart](#areachart)
25+
- [Initialization](#initialization)
26+
- [Example Usage](#example-usage)
27+
- [Features](#features)
28+
- [CandlestickChart](#candlestickchart)
29+
- [Initialization](#initialization)
30+
- [Example Usage](#example-usage)
31+
- [Features](#features)
32+
- [HeatmapChart](#heatmapchart)
33+
- [Initialization](#initialization)
34+
- [Example Usage](#example-usage)
35+
- [Features](#features)
36+
- [RadarChart](#radarchart)
37+
- [Initialization](#initialization)
38+
- [Example Usage](#example-usage)
39+
- [Features](#features)
40+
- [BubbleChart](#bubblechart)
41+
- [Initialization](#initialization)
42+
- [Example Usage](#example-usage)
43+
- [Features](#features)
44+
- [DonutChart](#donutchart)
45+
- [Initialization](#initialization)
46+
- [Example Usage](#example-usage)
47+
- [Features](#features)
48+
- [StackedBarChart](#stackedbarchart)
49+
- [Initialization](#initialization)
50+
- [Example Usage](#example-usage)
51+
- [Features](#features)
52+
- [MultiLineChart](#multilinechart)
53+
- [Initialization](#initialization)
54+
- [Example Usage](#example-usage)
55+
- [Features](#features)
56+
- [Common Features](#common-features)
57+
- [Styling](#styling)
58+
- [Animations](#animations)
59+
- [Interaction](#interaction)
60+
- [Accessibility](#accessibility)
61+
- [Performance](#performance)
62+
- [Best Practices](#best-practices)
63+
<!-- TOC END -->
64+
65+
366
This document provides comprehensive API documentation for all chart components in the SwiftUI Data Visualization framework.
467

568
## Table of Contents

Documentation/AccessibilityAPI.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,39 @@
11
# Accessibility API
22

3+
<!-- TOC START -->
4+
## Table of Contents
5+
- [Accessibility API](#accessibility-api)
6+
- [Overview](#overview)
7+
- [Core Components](#core-components)
8+
- [ChartAccessibility](#chartaccessibility)
9+
- [Accessibility Traits](#accessibility-traits)
10+
- [Usage Examples](#usage-examples)
11+
- [Basic Accessibility](#basic-accessibility)
12+
- [VoiceOver Support](#voiceover-support)
13+
- [Dynamic Type Support](#dynamic-type-support)
14+
- [VoiceOver Integration](#voiceover-integration)
15+
- [Data Point Accessibility](#data-point-accessibility)
16+
- [Navigation Support](#navigation-support)
17+
- [Dynamic Type](#dynamic-type)
18+
- [Font Scaling](#font-scaling)
19+
- [Layout Adaptation](#layout-adaptation)
20+
- [Color Accessibility](#color-accessibility)
21+
- [High Contrast Support](#high-contrast-support)
22+
- [Color Blind Support](#color-blind-support)
23+
- [Gesture Accessibility](#gesture-accessibility)
24+
- [VoiceOver Gestures](#voiceover-gestures)
25+
- [Switch Control Support](#switch-control-support)
26+
- [Screen Reader Support](#screen-reader-support)
27+
- [Descriptive Labels](#descriptive-labels)
28+
- [Context Information](#context-information)
29+
- [Testing Accessibility](#testing-accessibility)
30+
- [VoiceOver Testing](#voiceover-testing)
31+
- [Automated Testing](#automated-testing)
32+
- [Best Practices](#best-practices)
33+
- [Error Handling](#error-handling)
34+
<!-- TOC END -->
35+
36+
337
## Overview
438

539
The Accessibility API provides comprehensive support for VoiceOver, Dynamic Type, and other accessibility features. This API ensures that all charts are accessible to users with disabilities and comply with iOS accessibility guidelines.

Documentation/AccessibilityGuide.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,46 @@
11
# Accessibility Guide
22

3+
<!-- TOC START -->
4+
## Table of Contents
5+
- [Accessibility Guide](#accessibility-guide)
6+
- [Overview](#overview)
7+
- [Accessibility Fundamentals](#accessibility-fundamentals)
8+
- [VoiceOver Support](#voiceover-support)
9+
- [Basic VoiceOver Implementation](#basic-voiceover-implementation)
10+
- [VoiceOver Navigation](#voiceover-navigation)
11+
- [Dynamic Type Support](#dynamic-type-support)
12+
- [Font Scaling](#font-scaling)
13+
- [Layout Adaptation](#layout-adaptation)
14+
- [Color Accessibility](#color-accessibility)
15+
- [High Contrast Support](#high-contrast-support)
16+
- [Color Blind Support](#color-blind-support)
17+
- [Gesture Accessibility](#gesture-accessibility)
18+
- [VoiceOver Gestures](#voiceover-gestures)
19+
- [Switch Control Support](#switch-control-support)
20+
- [Screen Reader Support](#screen-reader-support)
21+
- [Descriptive Labels](#descriptive-labels)
22+
- [Context Information](#context-information)
23+
- [Testing Accessibility](#testing-accessibility)
24+
- [VoiceOver Testing](#voiceover-testing)
25+
- [Automated Testing](#automated-testing)
26+
- [Best Practices](#best-practices)
27+
- [1. Provide Descriptive Labels](#1-provide-descriptive-labels)
28+
- [2. Use Clear Hints](#2-use-clear-hints)
29+
- [3. Support Dynamic Type](#3-support-dynamic-type)
30+
- [4. High Contrast Support](#4-high-contrast-support)
31+
- [5. Color Blind Friendly](#5-color-blind-friendly)
32+
- [6. VoiceOver Navigation](#6-voiceover-navigation)
33+
- [7. Switch Control](#7-switch-control)
34+
- [8. Context Information](#8-context-information)
35+
- [9. Test Thoroughly](#9-test-thoroughly)
36+
- [10. Follow Guidelines](#10-follow-guidelines)
37+
- [Error Handling](#error-handling)
38+
- [Advanced Features](#advanced-features)
39+
- [Custom Accessibility Actions](#custom-accessibility-actions)
40+
- [Accessibility Notifications](#accessibility-notifications)
41+
<!-- TOC END -->
42+
43+
344
## Overview
445

546
The Accessibility Guide provides comprehensive information on making charts accessible to users with disabilities. This guide covers VoiceOver support, Dynamic Type, color accessibility, and other accessibility features to ensure inclusive data visualization.

Documentation/AnimationGuide.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,33 @@
11
# Animation Guide
22

3+
<!-- TOC START -->
4+
## Table of Contents
5+
- [Animation Guide](#animation-guide)
6+
- [Overview](#overview)
7+
- [Core Animation Components](#core-animation-components)
8+
- [ChartAnimation](#chartanimation)
9+
- [Animation Types](#animation-types)
10+
- [Basic Animations](#basic-animations)
11+
- [Fade Animation](#fade-animation)
12+
- [Scale Animation](#scale-animation)
13+
- [Slide Animation](#slide-animation)
14+
- [Data-Driven Animations](#data-driven-animations)
15+
- [Progressive Data Loading](#progressive-data-loading)
16+
- [Value Change Animation](#value-change-animation)
17+
- [Advanced Animations](#advanced-animations)
18+
- [Morphing Animations](#morphing-animations)
19+
- [Elastic Animations](#elastic-animations)
20+
- [Custom Animations](#custom-animations)
21+
- [Bezier Curve Animation](#bezier-curve-animation)
22+
- [Staggered Animations](#staggered-animations)
23+
- [Performance Optimization](#performance-optimization)
24+
- [Animation Performance](#animation-performance)
25+
- [Memory Management](#memory-management)
26+
- [Best Practices](#best-practices)
27+
- [Error Handling](#error-handling)
28+
<!-- TOC END -->
29+
30+
331
## Overview
432

533
The Animation Guide provides comprehensive information on creating smooth, engaging animations for charts and data visualizations. This guide covers various animation types, timing functions, and best practices for optimal user experience.

Documentation/BarChartAPI.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,38 @@
11
# Bar Chart API
22

3+
<!-- TOC START -->
4+
## Table of Contents
5+
- [Bar Chart API](#bar-chart-api)
6+
- [Overview](#overview)
7+
- [Core Components](#core-components)
8+
- [BarChart](#barchart)
9+
- [BarChartStyle](#barchartstyle)
10+
- [Usage Examples](#usage-examples)
11+
- [Basic Bar Chart](#basic-bar-chart)
12+
- [Horizontal Bar Chart](#horizontal-bar-chart)
13+
- [Customized Bar Chart](#customized-bar-chart)
14+
- [Interactive Features](#interactive-features)
15+
- [Touch Interactions](#touch-interactions)
16+
- [Animated Bar Chart](#animated-bar-chart)
17+
- [Performance Optimization](#performance-optimization)
18+
- [Large Dataset Handling](#large-dataset-handling)
19+
- [Real-time Updates](#real-time-updates)
20+
- [Customization Options](#customization-options)
21+
- [Color Schemes](#color-schemes)
22+
- [Typography](#typography)
23+
- [Animations](#animations)
24+
- [Accessibility](#accessibility)
25+
- [VoiceOver Support](#voiceover-support)
26+
- [Dynamic Type](#dynamic-type)
27+
- [Error Handling](#error-handling)
28+
- [Best Practices](#best-practices)
29+
- [Advanced Features](#advanced-features)
30+
- [Grouped Bar Charts](#grouped-bar-charts)
31+
- [Stacked Bar Charts](#stacked-bar-charts)
32+
- [Value Formatting](#value-formatting)
33+
<!-- TOC END -->
34+
35+
336
## Overview
437

538
The Bar Chart API provides comprehensive functionality for creating vertical and horizontal bar charts with grouping, stacking, and interactive features. This API is optimized for performance and supports large datasets.

Documentation/ChartAPI.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,31 @@
11
# Chart API
22

3+
<!-- TOC START -->
4+
## Table of Contents
5+
- [Chart API](#chart-api)
6+
- [Overview](#overview)
7+
- [Core Components](#core-components)
8+
- [Chart Protocol](#chart-protocol)
9+
- [ChartConfiguration](#chartconfiguration)
10+
- [Chart Types](#chart-types)
11+
- [Line Chart](#line-chart)
12+
- [Bar Chart](#bar-chart)
13+
- [Pie Chart](#pie-chart)
14+
- [Data Models](#data-models)
15+
- [DataPoint](#datapoint)
16+
- [Usage Examples](#usage-examples)
17+
- [Basic Line Chart](#basic-line-chart)
18+
- [Customized Bar Chart](#customized-bar-chart)
19+
- [Performance Optimization](#performance-optimization)
20+
- [Large Dataset Handling](#large-dataset-handling)
21+
- [Real-time Updates](#real-time-updates)
22+
- [Accessibility](#accessibility)
23+
- [VoiceOver Support](#voiceover-support)
24+
- [Error Handling](#error-handling)
25+
- [Best Practices](#best-practices)
26+
<!-- TOC END -->
27+
28+
329
## Overview
430

531
The Chart API provides the core functionality for creating and managing data visualizations in SwiftUI. This comprehensive API offers a wide range of chart types, customization options, and performance optimizations.

Documentation/ChartTypesGuide.md

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,58 @@
11
# Chart Types Guide
22

3+
<!-- TOC START -->
4+
## Table of Contents
5+
- [Chart Types Guide](#chart-types-guide)
6+
- [Overview](#overview)
7+
- [Available Chart Types](#available-chart-types)
8+
- [1. Line Charts](#1-line-charts)
9+
- [Use Cases](#use-cases)
10+
- [Implementation](#implementation)
11+
- [Features](#features)
12+
- [2. Bar Charts](#2-bar-charts)
13+
- [Use Cases](#use-cases)
14+
- [Implementation](#implementation)
15+
- [Features](#features)
16+
- [3. Pie Charts](#3-pie-charts)
17+
- [Use Cases](#use-cases)
18+
- [Implementation](#implementation)
19+
- [Features](#features)
20+
- [4. Scatter Plots](#4-scatter-plots)
21+
- [Use Cases](#use-cases)
22+
- [Implementation](#implementation)
23+
- [Features](#features)
24+
- [5. Area Charts](#5-area-charts)
25+
- [Use Cases](#use-cases)
26+
- [Implementation](#implementation)
27+
- [Features](#features)
28+
- [6. Candlestick Charts](#6-candlestick-charts)
29+
- [Use Cases](#use-cases)
30+
- [Implementation](#implementation)
31+
- [Features](#features)
32+
- [7. Heatmaps](#7-heatmaps)
33+
- [Use Cases](#use-cases)
34+
- [Implementation](#implementation)
35+
- [Features](#features)
36+
- [Chart Selection Guidelines](#chart-selection-guidelines)
37+
- [When to Use Each Chart Type](#when-to-use-each-chart-type)
38+
- [Line Charts](#line-charts)
39+
- [Bar Charts](#bar-charts)
40+
- [Pie Charts](#pie-charts)
41+
- [Scatter Plots](#scatter-plots)
42+
- [Area Charts](#area-charts)
43+
- [Candlestick Charts](#candlestick-charts)
44+
- [Heatmaps](#heatmaps)
45+
- [Advanced Features](#advanced-features)
46+
- [Multi-Series Charts](#multi-series-charts)
47+
- [Interactive Charts](#interactive-charts)
48+
- [Animated Charts](#animated-charts)
49+
- [Performance Considerations](#performance-considerations)
50+
- [Large Datasets](#large-datasets)
51+
- [Real-time Updates](#real-time-updates)
52+
- [Best Practices](#best-practices)
53+
<!-- TOC END -->
54+
55+
356
## Overview
457

558
The Chart Types Guide provides comprehensive information about all available chart types in the SwiftUI Data Visualization framework. This guide covers implementation details, use cases, and best practices for each chart type.

Documentation/CustomizationAPI.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,42 @@
11
# Customization API
22

3+
<!-- TOC START -->
4+
## Table of Contents
5+
- [Customization API](#customization-api)
6+
- [Overview](#overview)
7+
- [Core Components](#core-components)
8+
- [ChartColorScheme](#chartcolorscheme)
9+
- [ChartTypography](#charttypography)
10+
- [Color Customization](#color-customization)
11+
- [Custom Color Schemes](#custom-color-schemes)
12+
- [Brand Colors](#brand-colors)
13+
- [Dark Mode Support](#dark-mode-support)
14+
- [Typography Customization](#typography-customization)
15+
- [Custom Fonts](#custom-fonts)
16+
- [Dynamic Type Support](#dynamic-type-support)
17+
- [Layout Customization](#layout-customization)
18+
- [Spacing and Padding](#spacing-and-padding)
19+
- [Aspect Ratio](#aspect-ratio)
20+
- [Responsive Layout](#responsive-layout)
21+
- [Style Customization](#style-customization)
22+
- [Line Chart Styles](#line-chart-styles)
23+
- [Bar Chart Styles](#bar-chart-styles)
24+
- [Pie Chart Styles](#pie-chart-styles)
25+
- [Interactive Customization](#interactive-customization)
26+
- [Custom Gestures](#custom-gestures)
27+
- [Custom Callbacks](#custom-callbacks)
28+
- [Theme Customization](#theme-customization)
29+
- [Light Theme](#light-theme)
30+
- [Dark Theme](#dark-theme)
31+
- [Advanced Customization](#advanced-customization)
32+
- [Custom Renderers](#custom-renderers)
33+
- [Custom Animations](#custom-animations)
34+
- [Custom Modifiers](#custom-modifiers)
35+
- [Best Practices](#best-practices)
36+
- [Error Handling](#error-handling)
37+
<!-- TOC END -->
38+
39+
340
## Overview
441

542
The Customization API provides comprehensive tools for customizing chart appearance, behavior, and functionality. This API allows developers to create unique, branded visualizations that match their application's design language.

0 commit comments

Comments
 (0)