org.fujion.sparkline

Class CommonOptions

java.lang.Object

org.fujion.ancillary.Options

org.fujion.sparkline.CommonOptions

All Implemented Interfaces:

org.fujion.ancillary.IOptionMapTransform, org.fujion.client.IClientTransform

public class CommonOptions
extends org.fujion.ancillary.Options

Field Summary

Fields

Modifier and Type	Field and Description
protected Double	chartRangeMax The maximum value to use for the range of Y values of the chart
protected Double	chartRangeMin The minimum value to use for the range of Y values of the chart.
Boolean	disableHighlight Set to true to disable the highlighting of individual values when mousing over a sparkline.
Boolean	disableInteraction Set to true to disable all sparkline interactivity.
Boolean	disableTooltips Set to true to disable mouseover tooltips.
protected String	fillColor The color used to fill the area under the graph as a CSS value.
String	highlightColor If specified, then values that are moused over will be changed to this color instead of being lightend.
Double	highlightLighten Controls the amount to lighten or darken a value when moused over.
protected String	lineColor Used by line and discrete charts to specify the color of the line drawn as a CSS values string.
Character	numberDecimalMark Character to use for the decimal point in numbers for l10n purposes.
Integer	numberDigitGroupCount Number of digits between the group separator in numbers for l10n purposes.
Character	numberDigitGroupSep Character to use for group separator in numbers "1,234" for l10n purposes.
String	numberFormatter Pass a javascript function to control how numbers are formatted in tooltips.
String	tooltipChartTitle If specified then the tooltip uses the string specified by this setting as a title.
String	tooltipClassname Specifies a CSS class name to apply to tooltips to override the default built-in style.
String[]	tooltipFormat$array A format array to control the format of the tooltips.
String	tooltipFormat$string A format string to control the format of the tooltip.
String	tooltipFormatter Pass a javascript function to use as a callback to override the HTML used to generate tooltips.
Integer	tooltipOffsetX Specifies how many pixels away from the mouse pointer to render the tooltip on the X axis.
Double	tooltipOffsetY Specifies how many pixels away from the mouse pointer to render the tooltip on the Y axis.
String	tooltipPrefix A string to prepend to each field displayed in a tooltip.
String	tooltipSkipNull If true then null values will not have a tooltip displayed.
String	tooltipSuffix A string to append to each field displayed in a tooltip.
Map<String,String>	tooltipValueLookups An range map to map field values to tooltip strings.
protected SparklineType	type The type of sparkline.

Constructor Summary

Constructors

Constructor and Description
CommonOptions()

Method Summary

Methods inherited from class org.fujion.ancillary.Options

toMap

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.fujion.ancillary.IOptionMapTransform

transformForClient

Field Detail

type

@Option
protected SparklineType type

The type of sparkline.

Default: LINE

lineColor

@Option
protected String lineColor

Used by line and discrete charts to specify the color of the line drawn as a CSS values string.

fillColor

@Option
protected String fillColor

The color used to fill the area under the graph as a CSS value.

chartRangeMin

@Option
protected Double chartRangeMin

The minimum value to use for the range of Y values of the chart.

Default: the minimum value supplied

chartRangeMax

@Option
protected Double chartRangeMax

The maximum value to use for the range of Y values of the chart

Default: the maximum value supplied

disableInteraction

@Option
public Boolean disableInteraction

Set to true to disable all sparkline interactivity.

Default: false

disableTooltips

@Option
public Boolean disableTooltips

Set to true to disable mouseover tooltips.

Default: false

disableHighlight

@Option
public Boolean disableHighlight

Set to true to disable the highlighting of individual values when mousing over a sparkline.

Default: false

highlightLighten

@Option
public Double highlightLighten

Controls the amount to lighten or darken a value when moused over. A value of 1.5 will lighten by 50%, 0.5 will darken by 50%.

Default: 1.4

highlightColor

@Option
public String highlightColor

If specified, then values that are moused over will be changed to this color instead of being lightend.

tooltipClassname

@Option
public String tooltipClassname

Specifies a CSS class name to apply to tooltips to override the default built-in style.

tooltipOffsetX

@Option
public Integer tooltipOffsetX

Specifies how many pixels away from the mouse pointer to render the tooltip on the X axis.

tooltipOffsetY

@Option
public Double tooltipOffsetY

Specifies how many pixels away from the mouse pointer to render the tooltip on the Y axis.

tooltipFormatter

@Option(convertTo=org.fujion.ancillary.JavaScript.class)
public String tooltipFormatter

Pass a javascript function to use as a callback to override the HTML used to generate tooltips. The callback will be passed arguments of (sparkline, options, fields).

tooltipChartTitle

@Option
public String tooltipChartTitle

If specified then the tooltip uses the string specified by this setting as a title.

tooltipFormat$array

@Option(value="tooltipFormat")
public String[] tooltipFormat$array

A format array to control the format of the tooltips.

tooltipFormat$string

@Option(value="tooltipFormat")
public String tooltipFormat$string

A format string to control the format of the tooltip.

tooltipPrefix

@Option
public String tooltipPrefix

A string to prepend to each field displayed in a tooltip.

tooltipSuffix

@Option
public String tooltipSuffix

A string to append to each field displayed in a tooltip.

tooltipSkipNull

@Option
public String tooltipSkipNull

If true then null values will not have a tooltip displayed.

tooltipValueLookups

@Option
public Map<String,String> tooltipValueLookups

An range map to map field values to tooltip strings. For example you may want to map -1, 0 and 1 to the strings "Lost", "Draw", "Won".

numberFormatter

@Option(convertTo=org.fujion.ancillary.JavaScript.class)
public String numberFormatter

Pass a javascript function to control how numbers are formatted in tooltips. The callback will be passed a number to format and must return a string. Default behavior is to format numbers to western conventions.

numberDigitGroupSep

@Option
public Character numberDigitGroupSep

Character to use for group separator in numbers "1,234" for l10n purposes.

Default: ','

numberDecimalMark

@Option
public Character numberDecimalMark

Character to use for the decimal point in numbers for l10n purposes.

Default: '.'

numberDigitGroupCount

@Option
public Integer numberDigitGroupCount

Number of digits between the group separator in numbers for l10n purposes.

Default: 3

Constructor Detail

CommonOptions

public CommonOptions()