Constructors

Section titled "Constructors"

IgrSparkline 

new IgrSparkline(props: IIgrSparklineProps): IgrSparkline

Returns IgrSparkline

Accessors

Section titled "Accessors"

actualPixelScalingRatio

Section titled "actualPixelScalingRatio"

Gets the actual scaling value used by the component to affect the pixel density of the control. A higher scaling ratio will produce crisper visuals at the expense of memory. Lower values will cause the control to appear blurry.

 
get actualPixelScalingRatio(): number

Returns number 

set actualPixelScalingRatio(v: number): void

Parameters

  • v: number

Returns void

brush

Section titled "brush"

Gets or sets the sparkline brush.

 
get brush(): string

Returns string 

set brush(v: string): void

Parameters

  • v: string

Returns void

dataSource

Section titled "dataSource" 
get dataSource(): any

Returns any 

set dataSource(value: any): void

Parameters

  • value: any

Returns void

displayNormalRangeInFront

Section titled "displayNormalRangeInFront"

Gets or sets the position of the normal range on the sparkline.

 
get displayNormalRangeInFront(): boolean

Returns boolean 

set displayNormalRangeInFront(v: boolean): void

Parameters

  • v: boolean

Returns void

displayType

Section titled "displayType"

Gets or sets the display type of the sparkline.

 
get displayType(): SparklineDisplayType

Returns SparklineDisplayType 

set displayType(v: SparklineDisplayType): void

Parameters

Returns void

firstMarkerBrush

Section titled "firstMarkerBrush"

Gets or sets the first marker brush of the sparkline.

 
get firstMarkerBrush(): string

Returns string 

set firstMarkerBrush(v: string): void

Parameters

  • v: string

Returns void

firstMarkerSize

Section titled "firstMarkerSize"

Gets or sets the first marker size of the sparkline.

 
get firstMarkerSize(): number

Returns number 

set firstMarkerSize(v: number): void

Parameters

  • v: number

Returns void

firstMarkerVisibility

Section titled "firstMarkerVisibility"

Gets or sets the first marker visibility of the sparkline.

 
get firstMarkerVisibility(): Visibility

Returns Visibility 

set firstMarkerVisibility(v: Visibility): void

Parameters

  • v: Visibility

Returns void

formatLabel

Section titled "formatLabel"

Sets or gets a function which takes an object that produces a formatted label for displaying in the chart.

 
get formatLabel(): object

Returns object 

set formatLabel(v: object): void

Parameters

  • v: object

Returns void

height

Section titled "height" 
get height(): string

Returns string 

set height(value: string): void

Parameters

  • value: string

Returns void

highMarkerBrush

Section titled "highMarkerBrush"

Gets or sets the high marker brush of the sparkline.

 
get highMarkerBrush(): string

Returns string 

set highMarkerBrush(v: string): void

Parameters

  • v: string

Returns void

highMarkerSize

Section titled "highMarkerSize"

Gets or sets the high marker size of the sparkline.

 
get highMarkerSize(): number

Returns number 

set highMarkerSize(v: number): void

Parameters

  • v: number

Returns void

highMarkerVisibility

Section titled "highMarkerVisibility"

Gets or sets the high marker visibility of the sparkline.

 
get highMarkerVisibility(): Visibility

Returns Visibility 

set highMarkerVisibility(v: Visibility): void

Parameters

  • v: Visibility

Returns void

horizontalAxisBrush

Section titled "horizontalAxisBrush"

Gets or sets the horizontal axis line brush of the sparkline.

 
get horizontalAxisBrush(): string

Returns string 

set horizontalAxisBrush(v: string): void

Parameters

  • v: string

Returns void

horizontalAxisLabel

Section titled "horizontalAxisLabel"

The value or content to display on the horizontal axis. This can be set to a formatted string, such as "{0}", or it can be set to a DataTemplate.

 
get horizontalAxisLabel(): any

Returns any 

set horizontalAxisLabel(v: any): void

Parameters

  • v: any

Returns void

horizontalAxisVisibility

Section titled "horizontalAxisVisibility"

Gets or sets the display state of the horizontal axis.

 
get horizontalAxisVisibility(): Visibility

Returns Visibility 

set horizontalAxisVisibility(v: Visibility): void

Parameters

  • v: Visibility

Returns void

horizontalLabelFormat

Section titled "horizontalLabelFormat"

Gets or sets the label composite format used when creating label values.

 
get horizontalLabelFormat(): string

Returns string 

set horizontalLabelFormat(v: string): void

Parameters

  • v: string

Returns void

horizontalLabelFormatSpecifiers

Section titled "horizontalLabelFormatSpecifiers"

Gets or sets the format specifiers to use with the HorizontalLabelFormat string.

 
get horizontalLabelFormatSpecifiers(): any[]

Returns any[] 

set horizontalLabelFormatSpecifiers(v: any[]): void

Parameters

  • v: any[]

Returns void

labelMemberPath

Section titled "labelMemberPath"

String identifier of a column or property name to get labels from on each item in the data source. These labels will be retrieved from the first and last item, and displayed by the horizontal axis.

 
get labelMemberPath(): string

Returns string 

set labelMemberPath(v: string): void

Parameters

  • v: string

Returns void

lastMarkerBrush

Section titled "lastMarkerBrush"

Gets or sets the last marker brush of the sparkline.

 
get lastMarkerBrush(): string

Returns string 

set lastMarkerBrush(v: string): void

Parameters

  • v: string

Returns void

lastMarkerSize

Section titled "lastMarkerSize"

Gets or sets the last marker size of the sparkline.

 
get lastMarkerSize(): number

Returns number 

set lastMarkerSize(v: number): void

Parameters

  • v: number

Returns void

lastMarkerVisibility

Section titled "lastMarkerVisibility"

Gets or sets the last marker visibility of the sparkline.

 
get lastMarkerVisibility(): Visibility

Returns Visibility 

set lastMarkerVisibility(v: Visibility): void

Parameters

  • v: Visibility

Returns void

lineThickness

Section titled "lineThickness"

Gets or sets the line thickness of the sparkline.

 
get lineThickness(): number

Returns number 

set lineThickness(v: number): void

Parameters

  • v: number

Returns void

lowMarkerBrush

Section titled "lowMarkerBrush"

Gets or sets the low marker brush of the sparkline.

 
get lowMarkerBrush(): string

Returns string 

set lowMarkerBrush(v: string): void

Parameters

  • v: string

Returns void

lowMarkerSize

Section titled "lowMarkerSize"

Gets or sets the low marker size of the sparkline.

 
get lowMarkerSize(): number

Returns number 

set lowMarkerSize(v: number): void

Parameters

  • v: number

Returns void

lowMarkerVisibility

Section titled "lowMarkerVisibility"

Gets or sets the low marker visibility of the sparkline.

 
get lowMarkerVisibility(): Visibility

Returns Visibility 

set lowMarkerVisibility(v: Visibility): void

Parameters

  • v: Visibility

Returns void

markerBrush

Section titled "markerBrush"

Gets or sets the marker brush of the sparkline.

 
get markerBrush(): string

Returns string 

set markerBrush(v: string): void

Parameters

  • v: string

Returns void

markerSize

Section titled "markerSize"

Gets or sets the marker size of the sparkline.

 
get markerSize(): number

Returns number 

set markerSize(v: number): void

Parameters

  • v: number

Returns void

markerVisibility

Section titled "markerVisibility"

Gets or sets the marker visibility of the sparkline.

 
get markerVisibility(): Visibility

Returns Visibility 

set markerVisibility(v: Visibility): void

Parameters

  • v: Visibility

Returns void

maximum

Section titled "maximum"

Gets or sets the maximum value of the y axis.

 
get maximum(): number

Returns number 

set maximum(v: number): void

Parameters

  • v: number

Returns void

minimum

Section titled "minimum"

Gets or sets the minimum value of the y axis.

 
get minimum(): number

Returns number 

set minimum(v: number): void

Parameters

  • v: number

Returns void

nativeElement

Section titled "nativeElement" 
get nativeElement(): HTMLElement

Returns HTMLElement

negativeBrush

Section titled "negativeBrush"

Gets or sets the negative brush of the sparkline.

 
get negativeBrush(): string

Returns string 

set negativeBrush(v: string): void

Parameters

  • v: string

Returns void

negativeMarkerBrush

Section titled "negativeMarkerBrush"

Gets or sets the negative marker brush of the sparkline.

 
get negativeMarkerBrush(): string

Returns string 

set negativeMarkerBrush(v: string): void

Parameters

  • v: string

Returns void

negativeMarkerSize

Section titled "negativeMarkerSize"

Gets or sets the negative marker size of the sparkline.

 
get negativeMarkerSize(): number

Returns number 

set negativeMarkerSize(v: number): void

Parameters

  • v: number

Returns void

negativeMarkerVisibility

Section titled "negativeMarkerVisibility"

Gets or sets the negative marker visibility of the sparkline.

 
get negativeMarkerVisibility(): Visibility

Returns Visibility 

set negativeMarkerVisibility(v: Visibility): void

Parameters

  • v: Visibility

Returns void

normalRangeFill

Section titled "normalRangeFill"

Gets or sets the normal range brush of the sparkline.

 
get normalRangeFill(): string

Returns string 

set normalRangeFill(v: string): void

Parameters

  • v: string

Returns void

normalRangeMaximum

Section titled "normalRangeMaximum"

Gets or sets the maximum value of the normal range.

 
get normalRangeMaximum(): number

Returns number 

set normalRangeMaximum(v: number): void

Parameters

  • v: number

Returns void

normalRangeMinimum

Section titled "normalRangeMinimum"

Gets or sets the minimum value of the normal range.

 
get normalRangeMinimum(): number

Returns number 

set normalRangeMinimum(v: number): void

Parameters

  • v: number

Returns void

normalRangeVisibility

Section titled "normalRangeVisibility"

Gets or sets the normal range visibility of the sparkline.

 
get normalRangeVisibility(): Visibility

Returns Visibility 

set normalRangeVisibility(v: Visibility): void

Parameters

  • v: Visibility

Returns void

pixelScalingRatio

Section titled "pixelScalingRatio"

Gets or sets the scaling value used to affect the pixel density of the control. A higher scaling ratio will produce crisper visuals at the expense of memory. Lower values will cause the control to appear blurry.

 
get pixelScalingRatio(): number

Returns number 

set pixelScalingRatio(v: number): void

Parameters

  • v: number

Returns void

textColor

Section titled "textColor"

Gets or sets the text color for the axis labels.

 
get textColor(): string

Returns string 

set textColor(v: string): void

Parameters

  • v: string

Returns void

textStyle

Section titled "textStyle"

Gets or sets CSS font property for labels on X-axis

 
get textStyle(): string

Returns string 

set textStyle(v: string): void

Parameters

  • v: string

Returns void

tooltipTemplate

Section titled "tooltipTemplate" 
get tooltipTemplate(): any

Returns any 

set tooltipTemplate(value: any): void

Parameters

  • value: any

Returns void

trendLineBrush

Section titled "trendLineBrush"

Gets or sets the trendline brush of the sparkline.

 
get trendLineBrush(): string

Returns string 

set trendLineBrush(v: string): void

Parameters

  • v: string

Returns void

trendLinePeriod

Section titled "trendLinePeriod"

Gets or sets the trendline period used by the sparkline.

 
get trendLinePeriod(): number

Returns number 

set trendLinePeriod(v: number): void

Parameters

  • v: number

Returns void

trendLineThickness

Section titled "trendLineThickness"

Gets or sets the thickness of the sparkline's trendline.

 
get trendLineThickness(): number

Returns number 

set trendLineThickness(v: number): void

Parameters

  • v: number

Returns void

trendLineType

Section titled "trendLineType"

Gets or sets the type of trendline used by the sparkline.

 
get trendLineType(): TrendLineType

Returns TrendLineType 

set trendLineType(v: TrendLineType): void

Parameters

  • v: TrendLineType

Returns void

unknownValuePlotting

Section titled "unknownValuePlotting"

Gets or sets the way null values are interpreted.

 
get unknownValuePlotting(): UnknownValuePlotting

Returns UnknownValuePlotting 

set unknownValuePlotting(v: UnknownValuePlotting): void

Parameters

  • v: UnknownValuePlotting

Returns void

valueMemberPath

Section titled "valueMemberPath"

Gets or sets the string path to the value column.

 
get valueMemberPath(): string

Returns string 

set valueMemberPath(v: string): void

Parameters

  • v: string

Returns void

verticalAxisBrush

Section titled "verticalAxisBrush"

Gets or sets the vertical axis line brush of the sparkline.

 
get verticalAxisBrush(): string

Returns string 

set verticalAxisBrush(v: string): void

Parameters

  • v: string

Returns void

verticalAxisLabel

Section titled "verticalAxisLabel"

The value or content to display on the vertical axis. This can be set to a formatted string, such as "{0:n}", or it can be set to a DataTemplate.

 
get verticalAxisLabel(): any

Returns any 

set verticalAxisLabel(v: any): void

Parameters

  • v: any

Returns void

verticalAxisVisibility

Section titled "verticalAxisVisibility"

Gets or sets the display state of the vertical axis.

 
get verticalAxisVisibility(): Visibility

Returns Visibility 

set verticalAxisVisibility(v: Visibility): void

Parameters

  • v: Visibility

Returns void

verticalLabelFormat

Section titled "verticalLabelFormat"

Gets or sets the label composite format used when creating label values.

 
get verticalLabelFormat(): string

Returns string 

set verticalLabelFormat(v: string): void

Parameters

  • v: string

Returns void

verticalLabelFormatSpecifiers

Section titled "verticalLabelFormatSpecifiers"

Gets or sets the format specifiers to use with the VerticalLabelFormat string.

 
get verticalLabelFormatSpecifiers(): any[]

Returns any[] 

set verticalLabelFormatSpecifiers(v: any[]): void

Parameters

  • v: any[]

Returns void

width

Section titled "width" 
get width(): string

Returns string 

set width(value: string): void

Parameters

  • value: string

Returns void

Methods

Section titled "Methods"

componentDidMount

Section titled "componentDidMount" 
componentDidMount(): void

Returns void

componentWillUnmount

Section titled "componentWillUnmount" 
componentWillUnmount(): void

Returns void

destroy

Section titled "destroy" 
destroy(): void

Returns void

exportSerializedVisualData

Section titled "exportSerializedVisualData"

Returns visuals as a serialized string.

 
exportSerializedVisualData(): string

Returns string

exportVisualData

Section titled "exportVisualData"

Returns the sparkline visuals expressed as a SparklineVisualData object.

 
exportVisualData(): SparklineVisualData

Returns SparklineVisualData

findByName

Section titled "findByName" 
findByName(name: string): any

Parameters

  • name: string

Returns any

initializeContent

Section titled "initializeContent" 
initializeContent(): void

Returns void

notifyClearItems

Section titled "notifyClearItems"

Used to manually notify the SparklineComponent that the data source has reset or cleared its items. Invoking this method is only necessary if that datasource is not observable.

 
notifyClearItems(source_: any): void

Parameters

  • source_: any
    • The data source which was cleared or reset.

Returns void

notifyInsertItem

Section titled "notifyInsertItem" 
notifyInsertItem(source_: any, index: number, newItem: any): void

Parameters

  • source_: any
  • index: number
  • newItem: any

Returns void

notifyRemoveItem

Section titled "notifyRemoveItem" 
notifyRemoveItem(source_: any, index: number, oldItem: any): void

Parameters

  • source_: any
  • index: number
  • oldItem: any

Returns void

notifyResized

Section titled "notifyResized"

Notify that the control has resized.

 
notifyResized(): void

Returns void

notifySetItem

Section titled "notifySetItem" 
notifySetItem(source_: any, index: number, oldItem: any, newItem: any): void

Parameters

  • source_: any
  • index: number
  • oldItem: any
  • newItem: any

Returns void

provideContainer

Section titled "provideContainer"

Provides a container to the sparkline control.

 
provideContainer(container: any): void

Parameters

  • container: any
    • The container.

Returns void

render

Section titled "render" 
render(): DetailedReactHTMLElement<object, HTMLDivElement>

Returns DetailedReactHTMLElement<object, HTMLDivElement>

shouldComponentUpdate

Section titled "shouldComponentUpdate" 
shouldComponentUpdate(nextProps: any, nextState: any): boolean

Parameters

  • nextProps: any
  • nextState: any

Returns boolean

_createFromInternal

Section titled "_createFromInternal" 
_createFromInternal(internal: any): IgrSparkline

Parameters

  • internal: any

Returns IgrSparkline