Decorations : Additional elements added to graphs to increase data understanding
# decorations
Enables visual annotations on your graph, with its structure depending on the graphType. For network graphs, it is an array of node property names; for one-dimensional graphs, it is an object with primary keys like line, range, point, text, marker, or error; and for scatter plots, it is an object with primary keys such as linear, exponential, logarithmic, power, polynomial, nonlinearfit, regression, normal, line, text, label, point, range, image, or polygon. In the latter two cases, the value for each primary key is an array of objects, where each object specifies the properties of a decoration, for example, for a one-dimensional line: {line: [{value: 5, color: "#ff0000", width: 2, label: "Threshold", align: "right"}]}, or for a scatter plot linear fit: {linear: [{x: 1, y: 2, x2: 3, y2: 4, color: "#ff0000", width: 2, label: "Threshold", align: "right"}]}
Type:
object or array
Default:
decorations : {"line": [{"color": "red", "label": "Threshold", "width": 2, "y": 50}]}
decorations : {"point": [{"color": "rgba(0,0,255,0.3)", "label": "Marker - R11", "width": 15, "x": 41, "y": 53}]}
decorations : {"range": [{"color": "rgba(0,255,0,0.3)", "x": 0, "x2": 100, "y": 20, "y2": 40}]}
# decorationsBackgroundBorderColor
Color for the border in decoration legends background
Type:
color
Default:
rgb(204,204,204)
decorationsBackgroundBorderColor : "red"
decorationsBackgroundBorderColor : "black"
# decorationsBackgroundBorderLineType
Type of line for the border in decoration legends background
Type:
string
Default:
solid
decorationsBackgroundBorderLineType : "solid"
decorationsBackgroundBorderLineType : "dashed"
# decorationsBackgroundBorderSize
Size for the border line in decoration legends background
Type:
float
Default:
0.5
decorationsBackgroundBorderSize : 0.5
decorationsBackgroundBorderSize : 2
# decorationsBackgroundColor
Color for the decoration legends background
Type:
color
Default:
rgba(255,255,255,0)
decorationsBackgroundColor : "rgba(255,255,255,0)"
decorationsBackgroundColor : "lightyellow"
# decorationsClipped
Flag to clip decorations to the x,y area of the plot.
Type:
boolean
Default:
true
# decorationsColors
Array of colors used for the decorations. Only applicable to Network graphs
Type:
array
Default:
[]
decorationsColors : ["red", "blue", "green"]
decorationsColors : ["green", "orange", "purple"]
# decorationsHeight
Length in pixels of the height for the decorations. Only applicable to Network graphs.
Type:
integer
Default:
40
decorationsHeight : 80
decorationsHeight : 40
# decorationsOnTop
Flag to draw decorations after drawing the data. Not applicable to Network graphs
Type:
boolean
Default:
true
decorationsOnTop : true
decorationsOnTop : false
# decorationsPosition
Position for the the decorations
Type:
string
Default:
bottom
decorationsPosition : "bottom"
decorationsPosition : "right"
# decorationsProperties
Object to assign properties like color, position, etc. Only applicable to Network graphs
Type:
object
Default:
{}
# decorationsTextAlign
Alignment (or position) for the decoration legends
Type:
string
Default:
center
# decorationsTextBaseline
Baseline (or reference line) for the decoration legends
Type:
string
Default:
middle
# decorationsTextColor
Color for the text in decoration legends
Type:
color
Default:
rgb(0,0,0)
decorationsTextColor : "rgb(0,0,0)"
decorationsTextColor : "red"
decorationsTextColor : "blue"
# decorationsTextFontSize
Font size for the text in decoration legends. Be aware that auto scaling font must be turned off for this property to take effect. A more convenient way to modify the size is to use the decorationsTextScaleFontFactor
Type:
integer
Default:
11
# decorationsTextFontStyle
Font style for the decoration legends
Type:
string
Default:
decorationsTextFontStyle : ""
decorationsTextFontStyle : "bold"
decorationsTextFontStyle : "italic"
# decorationsTextMargin
Margin to pad or separate the characters in the decoration legends
Type:
float
Default:
5
decorationsTextMargin : 5
decorationsTextMargin : 10
decorationsTextMargin : 0
# decorationsTextRotate
Rotation in degrees for the decoration legends
Type:
integer
Default:
# decorationsTextScaleFontFactor
Scaling factor used to increase or decrease the decoration legends font size in the canvas
Type:
float
Default:
1
decorationsTextScaleFontFactor : 1
decorationsTextScaleFontFactor : 0.5
decorationsTextScaleFontFactor : 1.5
# decorationsTransform
Flag to transform the data in decorations produced in Cxplot. Not applicable to Network graphs
Type:
boolean
Default:
true
# decorationsTransparency
Transparency for range decorations type only. Also, it is not applicable to Network graphs
Type:
float
Default:
0.2
decorationsTransparency : 0.2
decorationsTransparency : 0.6
# decorationsType
Type for the decorations and only applicable to Network graphs. The types stacked and stackedpercent must be two dimensional. Heatmap could be one or two dimensional
Type:
string
Default:
bar
decorationsType : "pie"
decorationsType : "bar"
# decorationsWidth
Length in pixels of the width for the decorations. Only applicable to Network graphs.
Type:
integer
Default:
20
decorationsWidth : 20
decorationsWidth : 40
# showDecorations
Flag to show/hide the decorations
Type:
boolean
Default:
true
showDecorations : true
showDecorations : false
# showDecorationsBorder
Flag to show/hide the the decoration legends border
Type:
boolean
Default:
false
showDecorationsBorder : false
showDecorationsBorder : true
# showDecorationsLegend
Flag to show/hide the decoration legends
Type:
boolean
Default:
true
showDecorationsLegend : true
showDecorationsLegend : false
