add docstring for TextPlot

Author: sl-solution

src/charts/textplot.jl

@@ -1,18 +1,10 @@
-TEXT_DEFAULT = Dict{Symbol,Any}(:x => nothing, :y => nothing, :text => nothing,
-    :group => nothing,
-    :x2axis => false,
-    :y2axis => false, :opacity => 1,
-    :opacityresponse => nothing, :size => 10,
-    :font => nothing,
-    :fontweight => nothing,
-    :italic => nothing,
-    :limit => nothing,
-    :dir => :ltr, :align => :left, :textbaseline => :alphabetic, :angle => 0,
-    :angleresponse => nothing, :color => :black,
-    :colorresponse => nothing,
-    :colormodel => :diverging, :legend => nothing, #user must give a name to this if further customisation is needed for the legend
-    :clip => nothing
-)
+"""
+    TextPlot(args...)
+
+Represent a Text plot with given arguments.
+
+$(print_doc(TEXT_DEFAULT))
+"""
 mutable struct TextPlot <: SGMarks # we have to use TextPlot instead of Text, since Julia has a Text type already (although it is deprecated)
     opts
     function TextPlot(; opts...)

src/kwds.jl

@@ -373,6 +373,39 @@ HISTOGRAM_DEFAULT = SGKwds(
     :scale => __dic(:default=> :pdf, :__ord=>1, :__cat=>"Histogram Options", :__doc=>"The scale to use for the bar heights, e.g. `:pdf`, `:cdf`, `:count`."), 
 
 
+    :legend => __dic(:default=> nothing, :__ord=>6, :__cat=>"Legend", :__doc=>Kwds_docs[:legend]),
+
+    :clip => __dic(:default=> nothing, :__ord=>7, :__cat=>"Miscellaneous", :__doc=>Kwds_docs[:clip]),
+)
+
+TEXT_DEFAULT = SGKwds(
+    :x => __dic(:default=> nothing, :__ord=>0, :__cat => "Required", :__doc=>"The column to be used as x coordinate."),
+    :y => __dic(:default=> nothing, :__ord=>0, :__cat=> "Required", :__doc=>"The column to be used as y coordinate."),   
+    :text => __dic(:default=> nothing, :__ord=>0, :__cat=> "Required", :__doc=>"The column to be used as text values for each point."),    
+ 
+    :group => __dic(:default=> nothing, :__ord=>2, :__cat=>"Grouping", :__doc=>"The name of column for grouping observation. Each group of observations will create seperate text plot."),
+
+    :x2axis => __dic(:default=> false, :__ord=>5, :__cat=>"Axes options", :__doc=>Kwds_docs[:x2axis]),
+    :y2axis => __dic(:default=> false, :__ord=>5, :__cat=>"Axes options", :__doc=>Kwds_docs[:y2axis]),
+    
+    :opacity => __dic(:default=> 1, :__ord=>3, :__cat=>"TextPlot appearance", :__doc=>Kwds_docs[:opacity]),
+
+    :opacityresponse => __dic(:default=> nothing, :__ord=>1, :__cat=>"TextPlot Options", :__doc=>"The column which its values will be used to determine the opacity of text."),
+    :angleresponse => __dic(:default=> nothing, :__ord=>1, :__cat=>"TextPlot Options", :__doc=>"The column which its values will be used to determine the angle of text."),
+    :colorresponse => __dic(:default=> nothing, :__ord=>1, :__cat=>"TextPlot Options", :__doc=>"The column which its values will be used to determine the color of text."),
+    
+    :size => __dic(:default=> 10, :__ord=>3, :__cat=>"TextPlot appearance", :__doc=>Kwds_docs[:fontsize]),
+    :font => __dic(:default=> nothing, :__ord=>3, :__cat=>"TextPlot appearance", :__doc=>Kwds_docs[:font]),
+    :fontweight => __dic(:default=> nothing, :__ord=>3, :__cat=>"TextPlot appearance", :__doc=>Kwds_docs[:fontweight]),
+    :italic => __dic(:default=> nothing, :__ord=>3, :__cat=>"TextPlot appearance", :__doc=>Kwds_docs[:italic]),
+    :limit => __dic(:default=> nothing, :__ord=>3, :__cat=>"TextPlot appearance", :__doc=>Kwds_docs[:fontlimit]),
+    :dir => __dic(:default=> :ltr, :__ord=>3, :__cat=>"TextPlot appearance", :__doc=>Kwds_docs[:fontdir]),
+    :align => __dic(:default=> :left, :__ord=>3, :__cat=>"TextPlot appearance", :__doc=>Kwds_docs[:fontalign]),
+    :textbaseline => __dic(:default=> :alphabetic, :__ord=>3, :__cat=>"TextPlot appearance", :__doc=>Kwds_docs[:fontbaseline]),
+    :angle => __dic(:default=> 0, :__ord=>3, :__cat=>"TextPlot appearance", :__doc=>Kwds_docs[:fontangle]),
+    :color => __dic(:default=> :black, :__ord=>3, :__cat=>"TextPlot appearance", :__doc=>Kwds_docs[:fontcolor]),
+    :colormodel => __dic(:default=> :diverging, :__ord=>3, :__cat=>"TextPlot appearance", :__doc=>Kwds_docs[:colormodel]),
+
     :legend => __dic(:default=> nothing, :__ord=>6, :__cat=>"Legend", :__doc=>Kwds_docs[:legend]),
 
     :clip => __dic(:default=> nothing, :__ord=>7, :__cat=>"Miscellaneous", :__doc=>Kwds_docs[:clip]),