OptSparkline Module
- class epyk.core.html.options.OptSparkline.OptionsSpark(component: HtmlModel, attrs: Optional[dict] = None, options: Optional[dict] = None, js_tree: Optional[dict] = None, page: Optional[PageModel] = None)
- property chartRangeMax
Specify the maximum value to use for the range of Y values of the chart - Defaults to the maximum value supplied.
Related Pages:
- property chartRangeMin
Specify the minimum value to use for the range of Y values of the chart - Defaults to the minimum value supplied.
Related Pages:
- property composite
If true then don’t erase any existing chart attached to the tag, but draw another chart over the top.
Related Pages:
- property disableHiddenCheck
Set to true to disable checking for hidden sparklines.
Related Pages:
- property enableTagOptions
If true then options can be specified as attributes on each tag to be transformed into a sparkline, as well as passed to the sparkline() function. See also tagOptionPrefix.
Related Pages:
- property fillColor
Specify the colour used to fill the area under the graph as a CSS value. Set to false to disable fill.
Related Pages:
- property height
Height of the chart - Defaults to ‘auto’ (line height of the containing tag).
Related Pages:
- property lineColor
Used by line and discrete charts to specify the colour of the line drawn as a CSS values string.
Related Pages:
- property lineWidth
Related Pages:
- property tagOptionPrefix
String that each option passed as an attribute on a tag must begin with. Defaults to ‘spark’.
Related Pages:
- property tagValuesAttribute
The name of the tag attribute to fetch values from, if present - Defaults to ‘values’.
Related Pages:
- property width
Width of the chart - Defaults to ‘auto’ - May be any valid css width - 1.5em, 20px, etc (using a number without a unit specifier won’t do what you want) - This option does nothing for bar and tristate chars (see barWidth)/
Related Pages:
- class epyk.core.html.options.OptSparkline.OptionsSparkLine(component: HtmlModel, attrs: Optional[dict] = None, options: Optional[dict] = None, js_tree: Optional[dict] = None, page: Optional[PageModel] = None)
- property chartRangeMaxX
Specifies the maximum value to use for the X value of the chart.
Usage:
- property chartRangeMinX
Specifies the minimum value to use for the X value of the chart.
Usage:
- property defaultPixelsPerValue
Defaults to 3 pixels of width for each value in the chart.
Related Pages:
- property drawNormalOnTop
By default the normal range is drawn behind the fill area of the chart.
Usage:
- property highlightLineColor
Specifies a colour for the vertical line that appears through a value when moused over. Set to null to disable.
Usage:
- property highlightSpotColor
Specifies a colour for the spot that appears on a value when moused over. Set to null to disable.
Usage:
- property lineWidth
Integer.
Usage:
:type: In pixels (default
- property maxSpotColor
The CSS colour of the marker displayed for the maximum value. Set to false or an empty string to hide it.
Usage:
- property minSpotColor
The CSS colour of the marker displayed for the minimum value. Set to false or an empty string to hide it.
Usage:
- property normalRangeMax
Specify threshold values between which to draw a bar to denote the “normal” or expected range of values.
Usage:
- property normalRangeMin
Specify threshold values between which to draw a bar to denote the “normal” or expected range of values.
Usage:
- property spotColor
The CSS colour of the final value marker. Set to false or an empty string to hide it.
Usage:
- property spotRadius
1.5) - Integer.
Usage:
:type: Radius of all spot markers, In pixels (default
- property valueSpots
Specifies which points to draw spots on, and with which colour. Accepts a range.
Usage:
- property xvalues
By default the normal range is drawn behind the fill area of the chart.
Usage:
- class epyk.core.html.options.OptSparkline.OptionsSparkLineBar(component: HtmlModel, attrs: Optional[dict] = None, options: Optional[dict] = None, js_tree: Optional[dict] = None, page: Optional[PageModel] = None)
- property barColor
CSS colour used for postive values.
Related Pages:
- property barSpacing
Space between each bar, in pixels (integer).
Related Pages:
- property barWidth
Width of each bar, in pixels (integer).
Related Pages:
- property colorMap
A range map to map specific values to selected colours.
Related Pages:
- property negBarColor
CSS colour used for negative values.
Related Pages:
- property nullColor
CSS colour used for values equal to null.
Related Pages:
- property stackedBarColor
An array of colours to use for stacked bar charts.
Related Pages:
- property zeroAxis
Centers the y-axis at zero if true (default).
Related Pages:
- property zeroColor
CSS colour used for values equal to zero.
Related Pages:
- class epyk.core.html.options.OptSparkline.OptionsSparkLineBoxPlot(component: HtmlModel, attrs: Optional[dict] = None, options: Optional[dict] = None, js_tree: Optional[dict] = None, page: Optional[PageModel] = None)
- property boxFillColor
CSS fill colour used for the box.
Related Pages:
- property boxLineColor
CSS line colour used to outline the box.
Related Pages:
- property maxValue
If minvalue and maxvalue are set then the scale of the plot is fixed. By default minValue and maxValue are deduced from the values supplied.
Related Pages:
- property medianColor
CSS colour used to draw the median line.
Related Pages:
- property minValue
If minvalue and maxvalue are set then the scale of the plot is fixed. By default minValue and maxValue are deduced from the values supplied.
Related Pages:
- property outlierFillColor
CSS colour used to fill the outlier circles.
Related Pages:
- property outlierIQR
Set the inter-quartile range multipler used to calculate values that qualify as an outlier - Defaults to 1.5.
Related Pages:
- property outlierLineColor
CSS colour used to draw the outlier circles.
Related Pages:
- property raw
If set to false (default) then the values supplied are used to calculate the box data points for you.
Related Pages:
- property showOutliers
If true (default) then outliers (values > 1.5x the IQR) are marked with circles and the whiskers are placed at Q1 and Q3 instead of the least and greatest value
Related Pages:
- property spotRadius
Radius in pixels to draw the outlier circles.
Related Pages:
- property target
If set to a value, then a small crosshair is drawn at that point to represent a target value.
Related Pages:
- property targetColor
CSS colour used to draw the target crosshair, if set.
Related Pages:
- property whiskerColor
CSS colour used to draw the whiskers.
Related Pages:
- class epyk.core.html.options.OptSparkline.OptionsSparkLineBullet(component: HtmlModel, attrs: Optional[dict] = None, options: Optional[dict] = None, js_tree: Optional[dict] = None, page: Optional[PageModel] = None)
- property performanceColor
The CSS color of the performance measure horizontal bar.
Related Pages:
- property rangeColors
Colors to use for each qualitative range background color.
Related Pages:
- property targetColor
The CSS colour of the vertical target market.
Related Pages:
- property targetWidth
The width of the target marker in pixels (integer).
Related Pages:
- class epyk.core.html.options.OptSparkline.OptionsSparkLineDiscrete(component: HtmlModel, attrs: Optional[dict] = None, options: Optional[dict] = None, js_tree: Optional[dict] = None, page: Optional[PageModel] = None)
- property lineHeight
Height of each line in pixels.
Related Pages:
- property thresholdColor
Height of each line in pixels.
Related Pages:
- property thresholdValue
Height of each line in pixels.
Related Pages:
- class epyk.core.html.options.OptSparkline.OptionsSparkLinePie(component: HtmlModel, attrs: Optional[dict] = None, options: Optional[dict] = None, js_tree: Optional[dict] = None, page: Optional[PageModel] = None)
- property borderColor
CSS color to use to draw the pie border.
Related Pages:
- property borderWidth
Width of the border to draw around the whole pie chart, in pixels.
Related Pages:
- property offset
Angle in degrees to offset the first slice.
Related Pages:
- property sliceColors
An array of CSS colors to use for pie slices.
Related Pages:
- class epyk.core.html.options.OptSparkline.OptionsSparkLineTristate(component: HtmlModel, attrs: Optional[dict] = None, options: Optional[dict] = None, js_tree: Optional[dict] = None, page: Optional[PageModel] = None)
- property barSpacing
Space between each bar, in pixels (integer).
Related Pages:
- property barWidth
Width of each bar, in pixels (integer).
Related Pages:
- property colorMap
A range map to map specific values to selected colours.
Related Pages:
- property negBarColor
CSS colour for negative (lose) values.
Related Pages:
- property posBarColor
CSS colour for positive (win) values.
Related Pages:
- property zeroBarColor
CSS colour for zero (draw) values.
Related Pages: