Ignite UI for Angular

All
  • Public
  • Public/Protected
  • All

Class IgxSparklineComponent

Represents a sparkline chart.

Hierarchy

Hierarchy

  • IgxSparklineComponent

Implements

  • AfterContentInit
  • OnDestroy

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • Parameters

    • _renderer: Renderer2
    • _elRef: ViewContainerRef
    • _ngZone: NgZone
    • _componentFactoryResolver: ComponentFactoryResolver
    • _injector: Injector

    Returns IgxSparklineComponent

Properties

_dynamicContent

_dynamicContent: ViewContainerRef

Static ngAcceptInputType_actualPixelScalingRatio

ngAcceptInputType_actualPixelScalingRatio: string | number

Static ngAcceptInputType_displayNormalRangeInFront

ngAcceptInputType_displayNormalRangeInFront: string | boolean

Static ngAcceptInputType_displayType

ngAcceptInputType_displayType: string | SparklineDisplayType

Static ngAcceptInputType_firstMarkerSize

ngAcceptInputType_firstMarkerSize: string | number

Static ngAcceptInputType_firstMarkerVisibility

ngAcceptInputType_firstMarkerVisibility: string | Visibility

Static ngAcceptInputType_highMarkerSize

ngAcceptInputType_highMarkerSize: string | number

Static ngAcceptInputType_highMarkerVisibility

ngAcceptInputType_highMarkerVisibility: string | Visibility

Static ngAcceptInputType_horizontalAxisVisibility

ngAcceptInputType_horizontalAxisVisibility: string | Visibility

Static ngAcceptInputType_horizontalLabelFormatSpecifiers

ngAcceptInputType_horizontalLabelFormatSpecifiers: string | any[]

Static ngAcceptInputType_lastMarkerSize

ngAcceptInputType_lastMarkerSize: string | number

Static ngAcceptInputType_lastMarkerVisibility

ngAcceptInputType_lastMarkerVisibility: string | Visibility

Static ngAcceptInputType_lineThickness

ngAcceptInputType_lineThickness: string | number

Static ngAcceptInputType_lowMarkerSize

ngAcceptInputType_lowMarkerSize: string | number

Static ngAcceptInputType_lowMarkerVisibility

ngAcceptInputType_lowMarkerVisibility: string | Visibility

Static ngAcceptInputType_markerSize

ngAcceptInputType_markerSize: string | number

Static ngAcceptInputType_markerVisibility

ngAcceptInputType_markerVisibility: string | Visibility

Static ngAcceptInputType_maximum

ngAcceptInputType_maximum: string | number

Static ngAcceptInputType_minimum

ngAcceptInputType_minimum: string | number

Static ngAcceptInputType_negativeMarkerSize

ngAcceptInputType_negativeMarkerSize: string | number

Static ngAcceptInputType_negativeMarkerVisibility

ngAcceptInputType_negativeMarkerVisibility: string | Visibility

Static ngAcceptInputType_normalRangeMaximum

ngAcceptInputType_normalRangeMaximum: string | number

Static ngAcceptInputType_normalRangeMinimum

ngAcceptInputType_normalRangeMinimum: string | number

Static ngAcceptInputType_normalRangeVisibility

ngAcceptInputType_normalRangeVisibility: string | Visibility

Static ngAcceptInputType_pixelScalingRatio

ngAcceptInputType_pixelScalingRatio: string | number

Static ngAcceptInputType_trendLinePeriod

ngAcceptInputType_trendLinePeriod: string | number

Static ngAcceptInputType_trendLineThickness

ngAcceptInputType_trendLineThickness: string | number

Static ngAcceptInputType_trendLineType

ngAcceptInputType_trendLineType: string | TrendLineType

Static ngAcceptInputType_unknownValuePlotting

ngAcceptInputType_unknownValuePlotting: string | UnknownValuePlotting

Static ngAcceptInputType_verticalAxisVisibility

ngAcceptInputType_verticalAxisVisibility: string | Visibility

Static ngAcceptInputType_verticalLabelFormatSpecifiers

ngAcceptInputType_verticalLabelFormatSpecifiers: string | any[]

Static ɵcmp

ɵcmp: unknown

Static ɵfac

ɵfac: unknown

Accessors

actualPixelScalingRatio

  • get actualPixelScalingRatio(): 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.

    Returns number

  • set actualPixelScalingRatio(v: number): void

  • Parameters

    • v: number

    Returns void

brush

  • get brush(): string

  • Gets or sets the sparkline brush.

    Returns string

  • set brush(v: string): void

  • Parameters

    • v: string

    Returns void

dataSource

  • get dataSource(): any

  • Returns any

  • set dataSource(value: any): void

  • Parameters

    • value: any

    Returns void

displayNormalRangeInFront

  • get displayNormalRangeInFront(): boolean

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

    Returns boolean

  • set displayNormalRangeInFront(v: boolean): void

  • Parameters

    • v: boolean

    Returns void

displayType

firstMarkerBrush

  • get firstMarkerBrush(): string

  • Gets or sets the first marker brush of the sparkline.

    Returns string

  • set firstMarkerBrush(v: string): void

  • Parameters

    • v: string

    Returns void

firstMarkerSize

  • get firstMarkerSize(): number

  • Gets or sets the first marker size of the sparkline.

    Returns number

  • set firstMarkerSize(v: number): void

  • Parameters

    • v: number

    Returns void

firstMarkerVisibility

  • get firstMarkerVisibility(): Visibility

  • Gets or sets the first marker visibility of the sparkline.

    Returns Visibility

  • set firstMarkerVisibility(v: Visibility): void

  • Parameters

    Returns void

formatLabel

  • get formatLabel(): ((arg1: any) => string)

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

    Returns ((arg1: any) => string)

      • (arg1: any): 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

  • set formatLabel(v: ((arg1: any) => string)): void

  • Parameters

    • v: ((arg1: any) => string)
        • (arg1: any): string

        • Parameters

          • arg1: any

          Returns string

    Returns void

height

  • get height(): string

  • Returns string

  • set height(value: string): void

  • Parameters

    • value: string

    Returns void

highMarkerBrush

  • get highMarkerBrush(): string

  • Gets or sets the high marker brush of the sparkline.

    Returns string

  • set highMarkerBrush(v: string): void

  • Parameters

    • v: string

    Returns void

highMarkerSize

  • get highMarkerSize(): number

  • Gets or sets the high marker size of the sparkline.

    Returns number

  • set highMarkerSize(v: number): void

  • Parameters

    • v: number

    Returns void

highMarkerVisibility

  • get highMarkerVisibility(): Visibility

  • Gets or sets the high marker visibility of the sparkline.

    Returns Visibility

  • set highMarkerVisibility(v: Visibility): void

  • Parameters

    Returns void

horizontalAxisBrush

  • get horizontalAxisBrush(): string

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

    Returns string

  • set horizontalAxisBrush(v: string): void

  • Parameters

    • v: string

    Returns void

horizontalAxisLabel

  • get 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.

    Returns any

  • set horizontalAxisLabel(v: any): void

  • Parameters

    • v: any

    Returns void

horizontalAxisVisibility

  • get horizontalAxisVisibility(): Visibility

  • Gets or sets the display state of the horizontal axis.

    Returns Visibility

  • set horizontalAxisVisibility(v: Visibility): void

  • Parameters

    Returns void

horizontalLabelFormat

  • get horizontalLabelFormat(): string

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

    Returns string

  • set horizontalLabelFormat(v: string): void

  • Parameters

    • v: string

    Returns void

horizontalLabelFormatSpecifiers

  • get horizontalLabelFormatSpecifiers(): any[]

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

    Returns any[]

  • set horizontalLabelFormatSpecifiers(v: any[]): void

  • Parameters

    • v: any[]

    Returns void

labelMemberPath

  • get 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.

    Returns string

  • set labelMemberPath(v: string): void

  • Parameters

    • v: string

    Returns void

lastMarkerBrush

  • get lastMarkerBrush(): string

  • Gets or sets the last marker brush of the sparkline.

    Returns string

  • set lastMarkerBrush(v: string): void

  • Parameters

    • v: string

    Returns void

lastMarkerSize

  • get lastMarkerSize(): number

  • Gets or sets the last marker size of the sparkline.

    Returns number

  • set lastMarkerSize(v: number): void

  • Parameters

    • v: number

    Returns void

lastMarkerVisibility

  • get lastMarkerVisibility(): Visibility

  • Gets or sets the last marker visibility of the sparkline.

    Returns Visibility

  • set lastMarkerVisibility(v: Visibility): void

  • Parameters

    Returns void

lineThickness

  • get lineThickness(): number

  • Gets or sets the line thickness of the sparkline.

    Returns number

  • set lineThickness(v: number): void

  • Parameters

    • v: number

    Returns void

lowMarkerBrush

  • get lowMarkerBrush(): string

  • Gets or sets the low marker brush of the sparkline.

    Returns string

  • set lowMarkerBrush(v: string): void

  • Parameters

    • v: string

    Returns void

lowMarkerSize

  • get lowMarkerSize(): number

  • Gets or sets the low marker size of the sparkline.

    Returns number

  • set lowMarkerSize(v: number): void

  • Parameters

    • v: number

    Returns void

lowMarkerVisibility

  • get lowMarkerVisibility(): Visibility

  • Gets or sets the low marker visibility of the sparkline.

    Returns Visibility

  • set lowMarkerVisibility(v: Visibility): void

  • Parameters

    Returns void

markerBrush

  • get markerBrush(): string

  • Gets or sets the marker brush of the sparkline.

    Returns string

  • set markerBrush(v: string): void

  • Parameters

    • v: string

    Returns void

markerSize

  • get markerSize(): number

  • Gets or sets the marker size of the sparkline.

    Returns number

  • set markerSize(v: number): void

  • Parameters

    • v: number

    Returns void

markerVisibility

  • get markerVisibility(): Visibility

  • Gets or sets the marker visibility of the sparkline.

    Returns Visibility

  • set markerVisibility(v: Visibility): void

  • Parameters

    Returns void

maximum

  • get maximum(): number

  • Gets or sets the maximum value of the y axis.

    Returns number

  • set maximum(v: number): void

  • Parameters

    • v: number

    Returns void

minimum

  • get minimum(): number

  • Gets or sets the minimum value of the y axis.

    Returns number

  • set minimum(v: number): void

  • Parameters

    • v: number

    Returns void

negativeBrush

  • get negativeBrush(): string

  • Gets or sets the negative brush of the sparkline.

    Returns string

  • set negativeBrush(v: string): void

  • Parameters

    • v: string

    Returns void

negativeMarkerBrush

  • get negativeMarkerBrush(): string

  • Gets or sets the negative marker brush of the sparkline.

    Returns string

  • set negativeMarkerBrush(v: string): void

  • Parameters

    • v: string

    Returns void

negativeMarkerSize

  • get negativeMarkerSize(): number

  • Gets or sets the negative marker size of the sparkline.

    Returns number

  • set negativeMarkerSize(v: number): void

  • Parameters

    • v: number

    Returns void

negativeMarkerVisibility

  • get negativeMarkerVisibility(): Visibility

  • Gets or sets the negative marker visibility of the sparkline.

    Returns Visibility

  • set negativeMarkerVisibility(v: Visibility): void

  • Parameters

    Returns void

normalRangeFill

  • get normalRangeFill(): string

  • Gets or sets the normal range brush of the sparkline.

    Returns string

  • set normalRangeFill(v: string): void

  • Parameters

    • v: string

    Returns void

normalRangeMaximum

  • get normalRangeMaximum(): number

  • Gets or sets the maximum value of the normal range.

    Returns number

  • set normalRangeMaximum(v: number): void

  • Parameters

    • v: number

    Returns void

normalRangeMinimum

  • get normalRangeMinimum(): number

  • Gets or sets the minimum value of the normal range.

    Returns number

  • set normalRangeMinimum(v: number): void

  • Parameters

    • v: number

    Returns void

normalRangeVisibility

  • get normalRangeVisibility(): Visibility

  • Gets or sets the normal range visibility of the sparkline.

    Returns Visibility

  • set normalRangeVisibility(v: Visibility): void

  • Parameters

    Returns void

pixelScalingRatio

  • get pixelScalingRatio(): 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.

    Returns number

  • set pixelScalingRatio(v: number): void

  • Parameters

    • v: number

    Returns void

tooltipTemplate

  • get tooltipTemplate(): TemplateRef<any>

  • Returns TemplateRef<any>

  • set tooltipTemplate(value: TemplateRef<any>): void

  • Parameters

    • value: TemplateRef<any>

    Returns void

trendLineBrush

  • get trendLineBrush(): string

  • Gets or sets the trendline brush of the sparkline.

    Returns string

  • set trendLineBrush(v: string): void

  • Parameters

    • v: string

    Returns void

trendLinePeriod

  • get trendLinePeriod(): number

  • Gets or sets the trendline period used by the sparkline.

    Returns number

  • set trendLinePeriod(v: number): void

  • Parameters

    • v: number

    Returns void

trendLineThickness

  • get trendLineThickness(): number

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

    Returns number

  • set trendLineThickness(v: number): void

  • Parameters

    • v: number

    Returns void

trendLineType

  • get trendLineType(): TrendLineType

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

    Returns TrendLineType

  • set trendLineType(v: TrendLineType): void

  • Parameters

    Returns void

unknownValuePlotting

valueMemberPath

  • get valueMemberPath(): string

  • Gets or sets the string path to the value column.

    Returns string

  • set valueMemberPath(v: string): void

  • Parameters

    • v: string

    Returns void

verticalAxisBrush

  • get verticalAxisBrush(): string

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

    Returns string

  • set verticalAxisBrush(v: string): void

  • Parameters

    • v: string

    Returns void

verticalAxisLabel

  • get 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.

    Returns any

  • set verticalAxisLabel(v: any): void

  • Parameters

    • v: any

    Returns void

verticalAxisVisibility

  • get verticalAxisVisibility(): Visibility

  • Gets or sets the display state of the vertical axis.

    Returns Visibility

  • set verticalAxisVisibility(v: Visibility): void

  • Parameters

    Returns void

verticalLabelFormat

  • get verticalLabelFormat(): string

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

    Returns string

  • set verticalLabelFormat(v: string): void

  • Parameters

    • v: string

    Returns void

verticalLabelFormatSpecifiers

  • get verticalLabelFormatSpecifiers(): any[]

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

    Returns any[]

  • set verticalLabelFormatSpecifiers(v: any[]): void

  • Parameters

    • v: any[]

    Returns void

width

  • get width(): string

  • Returns string

  • set width(value: string): void

  • Parameters

    • value: string

    Returns void

Methods

exportSerializedVisualData

  • Returns visuals as a serialized string.

    Returns string

exportVisualData

  • Returns the sparkline visuals expressed as a SparklineVisualData object.

    Returns SparklineVisualData

findByName

  • Parameters

    • name: string

    Returns any

ngAfterContentInit

  • Returns void

ngOnDestroy

  • Returns void

notifyClearItems

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

    Parameters

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

    Returns void

notifyInsertItem

  • Parameters

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

    Returns void

notifyRemoveItem

  • Parameters

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

    Returns void

notifyResized

  • Notify that the control has resized.

    Returns void

notifySetItem

  • Parameters

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

    Returns void

provideContainer

  • Provides a container to the sparkline control.

    Parameters

    • container: any
      • The container.

    Returns void

Static _createFromInternal