Highlight

Quick Start

Creates a highlight definition that can be used in the aggregation "highlights" of a graphomate.ui.charts.Chart. Depending on the value of the charts property "highlightMode" all, one or none of the aggregated highlights will be rendered as small deviation markers in the chart. They can be used to emphasize deviations between two specific values. 

var chart = new graphomate.ui.charts.Chart({
    chartType: graphomate.ui.charts.enums.ChartType.Bar,
    series1: [5, 16, 17, 20],
    highlightMode: graphomate.ui.charts.enums.HighlightMode.Single,
    highlights:[
    	new graphomate.ui.charts.Highlight({
			startElement: 1,
	        endElement: 3
		})
    ]
});

Constructor Details

new graphomate.ui.charts.Highlight(id?:string, settings?:object)

Accepts an id and a settings object or one or none of them. The settings object defines initial property values. Every setting can also be set using the related setter method. The supported settings are:

Properties:

• startSeries : graphomate.ui.types.UnsignedInteger (default: 0)
• endSeries : graphomate.ui.types.UnsignedInteger (default: 0)
• startElement : graphomate.ui.types.UnsignedInteger (default: 0)
• endElement : graphomate.ui.types.UnsignedInteger (default: 1)

Property Details

Each property "sampleProperty" can be set using the related setter "setSampleProperty". Each setter expects a valid value for the related property as input parameter and throws an exception for invalid values. It returns the "this context" for method chaining. Each property "sampleProperty" can also be gotten using the related getter method "getSampleProperty". It expects no input parameters and returns the current value of the related property. Each property that represents or partially contains indices excepts a 0 based index.

The following properties are available: