Ignite UI for React

All
  • Public
  • Public/Protected
  • All

Interface IIgrSparklineProps

Hierarchy

Hierarchy

  • IIgrSparklineProps

Properties

Properties

Optional actualPixelScalingRatio

actualPixelScalingRatio?: string | number

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.

Optional brush

brush?: string

Gets or sets the sparkline brush.

Optional children

children?: ReactNode

Optional dataSource

dataSource?: any

Optional displayNormalRangeInFront

displayNormalRangeInFront?: string | boolean

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

Optional displayType

displayType?: string | SparklineDisplayType

Gets or sets the display type of the sparkline.

Optional firstMarkerBrush

firstMarkerBrush?: string

Gets or sets the first marker brush of the sparkline.

Optional firstMarkerSize

firstMarkerSize?: string | number

Gets or sets the first marker size of the sparkline.

Optional firstMarkerVisibility

firstMarkerVisibility?: string | Visibility

Gets or sets the first marker visibility of the sparkline.

Optional formatLabel

formatLabel?: ((arg1) => string)

Type declaration

    • (arg1): string

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

      Parameters

      • arg1: any

      Returns string

Optional height

height?: string

Optional highMarkerBrush

highMarkerBrush?: string

Gets or sets the high marker brush of the sparkline.

Optional highMarkerSize

highMarkerSize?: string | number

Gets or sets the high marker size of the sparkline.

Optional highMarkerVisibility

highMarkerVisibility?: string | Visibility

Gets or sets the high marker visibility of the sparkline.

Optional horizontalAxisBrush

horizontalAxisBrush?: string

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

Optional horizontalAxisLabel

horizontalAxisLabel?: any

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.

Optional horizontalAxisVisibility

horizontalAxisVisibility?: string | Visibility

Gets or sets the display state of the horizontal axis.

Optional horizontalLabelFormat

horizontalLabelFormat?: string

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

Optional horizontalLabelFormatSpecifiers

horizontalLabelFormatSpecifiers?: any[]

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

Optional labelMemberPath

labelMemberPath?: string

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.

Optional lastMarkerBrush

lastMarkerBrush?: string

Gets or sets the last marker brush of the sparkline.

Optional lastMarkerSize

lastMarkerSize?: string | number

Gets or sets the last marker size of the sparkline.

Optional lastMarkerVisibility

lastMarkerVisibility?: string | Visibility

Gets or sets the last marker visibility of the sparkline.

Optional lineThickness

lineThickness?: string | number

Gets or sets the line thickness of the sparkline.

Optional lowMarkerBrush

lowMarkerBrush?: string

Gets or sets the low marker brush of the sparkline.

Optional lowMarkerSize

lowMarkerSize?: string | number

Gets or sets the low marker size of the sparkline.

Optional lowMarkerVisibility

lowMarkerVisibility?: string | Visibility

Gets or sets the low marker visibility of the sparkline.

Optional markerBrush

markerBrush?: string

Gets or sets the marker brush of the sparkline.

Optional markerSize

markerSize?: string | number

Gets or sets the marker size of the sparkline.

Optional markerVisibility

markerVisibility?: string | Visibility

Gets or sets the marker visibility of the sparkline.

Optional maximum

maximum?: string | number

Gets or sets the maximum value of the y axis.

Optional minimum

minimum?: string | number

Gets or sets the minimum value of the y axis.

Optional negativeBrush

negativeBrush?: string

Gets or sets the negative brush of the sparkline.

Optional negativeMarkerBrush

negativeMarkerBrush?: string

Gets or sets the negative marker brush of the sparkline.

Optional negativeMarkerSize

negativeMarkerSize?: string | number

Gets or sets the negative marker size of the sparkline.

Optional negativeMarkerVisibility

negativeMarkerVisibility?: string | Visibility

Gets or sets the negative marker visibility of the sparkline.

Optional normalRangeFill

normalRangeFill?: string

Gets or sets the normal range brush of the sparkline.

Optional normalRangeMaximum

normalRangeMaximum?: string | number

Gets or sets the maximum value of the normal range.

Optional normalRangeMinimum

normalRangeMinimum?: string | number

Gets or sets the minimum value of the normal range.

Optional normalRangeVisibility

normalRangeVisibility?: string | Visibility

Gets or sets the normal range visibility of the sparkline.

Optional pixelScalingRatio

pixelScalingRatio?: string | number

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.

Optional tooltipTemplate

tooltipTemplate?: FunctionComponent<IChartTooltipProps> | Component<IChartTooltipProps, {}, any>

Optional trendLineBrush

trendLineBrush?: string

Gets or sets the trendline brush of the sparkline.

Optional trendLinePeriod

trendLinePeriod?: string | number

Gets or sets the trendline period used by the sparkline.

Optional trendLineThickness

trendLineThickness?: string | number

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

Optional trendLineType

trendLineType?: string | TrendLineType

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

Optional unknownValuePlotting

unknownValuePlotting?: string | UnknownValuePlotting

Gets or sets the way null values are interpreted.

Optional valueMemberPath

valueMemberPath?: string

Gets or sets the string path to the value column.

Optional verticalAxisBrush

verticalAxisBrush?: string

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

Optional verticalAxisLabel

verticalAxisLabel?: any

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.

Optional verticalAxisVisibility

verticalAxisVisibility?: string | Visibility

Gets or sets the display state of the vertical axis.

Optional verticalLabelFormat

verticalLabelFormat?: string

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

Optional verticalLabelFormatSpecifiers

verticalLabelFormatSpecifiers?: any[]

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

Optional width

width?: string