Merge pull request #49 from randyzwitch/wai_aria

WAI-ARIA compatibility

Author: randyzwitch

docs/_data/sidebars/mydoc_sidebar.yml

@@ -104,6 +104,10 @@ entries:
     output: web
     folderitems:
 
+    - title: aria!
+      url: /aria
+      output: web
+
     - title: colorscheme!
       url: /colorscheme
       output: web

docs/aria.md

@@ -0,0 +1,37 @@
+---
+title: aria!
+sidebar: mydoc_sidebar
+permalink: /aria
+---
+This method implements the [Web Accessibility Initiative – Accessible Rich Internet Applications](https://www.w3.org/WAI/intro/aria) (WAI-ARIA) functionality that is built into the echarts.js library. echarts.js attempts to [auto-generate valid accessibility tags](http://echarts.baidu.com/option.html#aria), descriptions, etc. based on `ECharts` data such as `Title`.
+
+If you need finer-grained control, the `aria!()` method allows for overriding the auto-generated descriptions and tags.
+
+## Method Signatures
+{% highlight julia %}
+aria!(ec::EChart; show::Bool = true, description::String = "", general::Dict = Dict(), series::Dict = Dict(), data::Dict = Dict())
+{% endhighlight %}
+
+## Optional Arguments
+{% highlight julia %}
+None currently
+{% endhighlight %}
+
+## Examples
+
+### `palette`
+{% highlight julia %}
+
+{% endhighlight %}
+
+<div id="color1" style="height:400px;width:800px;"></div>
+<script type="text/javascript">
+
+    // Initialize after dom ready
+    var myChart = echarts.init(document.getElementById("color1"), JSON.parse(roma()));
+
+    // Load data into the ECharts instance
+    myChart.setOption(
+
+        );
+</script>

src/ECharts.jl

@@ -35,7 +35,7 @@ module ECharts
 
 	export title!, yaxis!, xaxis!, toolbox!, colorscheme!, flip!, seriesnames!, legend!, slider!, smooth!
 	export yline!, xline!, lineargradient, radialgradient, text!, xarea!, yarea!, xgridlines!, ygridlines!
-	export radial!, jitter!, labels!, theme!, tooltip!
+	export radial!, jitter!, labels!, theme!, tooltip!, aria!
 
 	#This is a package local function, it is NOT overloading JSON.json
 	#Define custom JSON serialization rule
@@ -78,6 +78,7 @@ module ECharts
 	include("chartopts/theme.jl")
 	include("chartopts/radial.jl")
 	include("chartopts/gradients.jl")
+	include("chartopts/aria.jl")
 
 	#Plots
 	include("plots/xy_plot.jl")

src/chartopts/aria.jl

@@ -0,0 +1,6 @@
+function aria!(ec::EChart; show::Bool = true, description::Union{String, Void} = nothing, general::Union{Dict, Void} = nothing, series::Union{Dict, Void} = nothing, data::Union{Dict, Void} = nothing)
+
+    ec.aria = Aria(show = show, description = description, general = general, series = series, data = data)
+    return ec
+
+end

src/definetypes.jl

@@ -679,7 +679,7 @@ end
     sourceHeader::Union{Bool, Void} = nothing
 end
 @with_kw mutable struct Aria <: AbstractEChartType
-    show::Union{Bool, Void} = nothing
+    show::Union{Bool, Void} = true
     description::Union{String, Void} = nothing
     general::Union{Dict, Void} = nothing
     series::Union{Dict, Void} = nothing
@@ -1405,7 +1405,7 @@ end
     graphic::Union{Graphic,Void} = nothing
     calendar::Union{Calendar,Void} = nothing
     dataset::Union{Dataset, Void} = nothing
-    aria::Union{Aria, Void} = nothing
+    aria::Union{Aria, Void} = Aria()
     series::Union{AbstractVector{<:AbstractEChartSeries},Void} = nothing
     color::Union{AbstractVector,JSFunction,Void} = nothing
     backgroundColor::Union{String,Void, JSFunction} = nothing