Class IgrPieChartBase<P, SS>

Represents the base class for the pie chart.

Type parameters

Hierarchy

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • Parameters

    • props: P

    Returns IgrPieChartBase

Properties

context

context: any

If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType.

static contextType = MyContext
context!: React.ContextType<typeof MyContext>
deprecated

if used without a type annotation, or without static contextType

see

https://reactjs.org/docs/legacy-context.html

props

props: Readonly<P> & Readonly<object>

refs

refs: object

Type declaration

  • [key: string]: ReactInstance

state

state: Readonly<__type>

Static Optional contextType

contextType: Context<any>

If set, this.context will be set at runtime to the current value of the given Context.

Usage:

type MyContext = number
const Ctx = React.createContext<MyContext>(0)

class Foo extends React.Component {
  static contextType = Ctx
  context!: React.ContextType<typeof Ctx>
  render () {
    return <>My context's value: {this.context}</>;
  }
}
see

https://reactjs.org/docs/context.html#classcontexttype

Accessors

actualPixelScalingRatio

  • get actualPixelScalingRatio(): number
  • set actualPixelScalingRatio(v: number): void
  • Resolved pixel scaling ratio. Unless explicitly overridden by the PieChartBase.PixelScalingRatio property, this one returns the default ratio enforced by device. High resolution devices will initialize this property to a higher value.

    Returns number

  • Resolved pixel scaling ratio. Unless explicitly overridden by the PieChartBase.PixelScalingRatio property, this one returns the default ratio enforced by device. High resolution devices will initialize this property to a higher value.

    Parameters

    • v: number

    Returns void

allowSliceExplosion

  • get allowSliceExplosion(): boolean
  • set allowSliceExplosion(v: boolean): void
  • Gets or sets whether the slices can be exploded.

    Returns boolean

  • Gets or sets whether the slices can be exploded.

    Parameters

    • v: boolean

    Returns void

allowSliceSelection

  • get allowSliceSelection(): boolean
  • set allowSliceSelection(v: boolean): void
  • Gets or sets whether the slices can be selected.

    Returns boolean

  • Gets or sets whether the slices can be selected.

    Parameters

    • v: boolean

    Returns void

brushes

  • get brushes(): string[]
  • set brushes(v: string[]): void
  • Gets or sets the palette of brushes to use for coloring the slices.

    Returns string[]

  • Gets or sets the palette of brushes to use for coloring the slices.

    Parameters

    • v: string[]

    Returns void

explodedRadius

  • get explodedRadius(): number
  • set explodedRadius(v: number): void
  • Determines how much the exploded slice is offset from the center. Value between 0 and 1.

    Returns number

  • Determines how much the exploded slice is offset from the center. Value between 0 and 1.

    Parameters

    • v: number

    Returns void

explodedSlices

  • Gets or sets the collection of exploded slice indices.

    Returns IgrIndexCollection

  • Gets or sets the collection of exploded slice indices.

    Parameters

    Returns void

formatLabel

  • get formatLabel(): function
  • set formatLabel(v: function): void
  • Sets or gets a function which takes an object that produces a formatted label for displaying in the chart.

    Returns function

      • (obj: any): string
      • Parameters

        • obj: any

        Returns string

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

    Parameters

    • v: function
        • (obj: any): string
        • Parameters

          • obj: any

          Returns string

    Returns void

formatLegendLabel

  • get formatLegendLabel(): function
  • set formatLegendLabel(v: function): void
  • Sets or gets a function which takes an object that produces a formatted label for displaying in the chart's legend.

    Returns function

      • (obj: any): string
      • Parameters

        • obj: any

        Returns string

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

    Parameters

    • v: function
        • (obj: any): string
        • Parameters

          • obj: any

          Returns string

    Returns void

innerExtent

  • get innerExtent(): number
  • set innerExtent(v: number): void
  • Gets or sets the amount of space between the center and the start of the arc. This property should be set between 0 and 1. If InnerExtent is set to a value greater than 1, it will be interpreted as a percentage, effectively divided by 100.

    Returns number

  • Gets or sets the amount of space between the center and the start of the arc. This property should be set between 0 and 1. If InnerExtent is set to a value greater than 1, it will be interpreted as a percentage, effectively divided by 100.

    Parameters

    • v: number

    Returns void

isSurfaceInteractionDisabled

  • get isSurfaceInteractionDisabled(): boolean
  • set isSurfaceInteractionDisabled(v: boolean): void
  • Gets or sets whether all surface interactions with the plot area should be disabled.

    Returns boolean

  • Gets or sets whether all surface interactions with the plot area should be disabled.

    Parameters

    • v: boolean

    Returns void

labelClick

  • get labelClick(): function
  • set labelClick(ev: function): void

labelExtent

  • get labelExtent(): number
  • set labelExtent(v: number): void
  • Gets or sets the pixel amount by which the labels are offset from the edge of the slices.

    Returns number

  • Gets or sets the pixel amount by which the labels are offset from the edge of the slices.

    Parameters

    • v: number

    Returns void

labelInnerColor

  • get labelInnerColor(): string
  • set labelInnerColor(v: string): void
  • Gets or sets the color for labels rendered inside of the pie chart.

    Returns string

  • Gets or sets the color for labels rendered inside of the pie chart.

    Parameters

    • v: string

    Returns void

labelMemberPath

  • get labelMemberPath(): string
  • set labelMemberPath(v: string): void
  • Gets or sets the property name that contains the labels.

    Returns string

  • Gets or sets the property name that contains the labels.

    Parameters

    • v: string

    Returns void

labelOuterColor

  • get labelOuterColor(): string
  • set labelOuterColor(v: string): void
  • Gets or sets the color for labels rendered outside of the pie chart.

    Returns string

  • Gets or sets the color for labels rendered outside of the pie chart.

    Parameters

    • v: string

    Returns void

labelsPosition

  • Gets or sets the position of chart labels.

    Returns LabelsPosition

  • Gets or sets the position of chart labels.

    Parameters

    Returns void

leaderLineMargin

  • get leaderLineMargin(): number
  • set leaderLineMargin(v: number): void
  • Gets or sets the margin between a label and the end of its leader line. The default is 6 pixels.

    Returns number

  • Gets or sets the margin between a label and the end of its leader line. The default is 6 pixels.

    Parameters

    • v: number

    Returns void

leaderLineType

  • Gets or sets what type of leader lines will be used for the outside end labels.

    Returns LeaderLineType

  • Gets or sets what type of leader lines will be used for the outside end labels.

    Parameters

    Returns void

leaderLineVisibility

  • get leaderLineVisibility(): Visibility
  • set leaderLineVisibility(v: Visibility): void
  • Gets or sets whether the leader lines are visible.

    Returns Visibility

  • Gets or sets whether the leader lines are visible.

    Parameters

    • v: Visibility

    Returns void

legendItemBadgeTemplate

  • get legendItemBadgeTemplate(): IgDataTemplate
  • set legendItemBadgeTemplate(v: IgDataTemplate): void
  • Gets or sets the LegendItemBadgeTemplate property. The legend item badge is created according to the LegendItemBadgeTemplate on-demand by the chart object itself.

    Returns IgDataTemplate

  • Gets or sets the LegendItemBadgeTemplate property. The legend item badge is created according to the LegendItemBadgeTemplate on-demand by the chart object itself.

    Parameters

    • v: IgDataTemplate

    Returns void

legendItemTemplate

  • get legendItemTemplate(): IgDataTemplate
  • set legendItemTemplate(v: IgDataTemplate): void
  • Gets or sets the LegendItemTemplate property. The legend item control content is created according to the LegendItemTemplate on-demand by the chart object itself.

    Returns IgDataTemplate

  • Gets or sets the LegendItemTemplate property. The legend item control content is created according to the LegendItemTemplate on-demand by the chart object itself.

    Parameters

    • v: IgDataTemplate

    Returns void

legendLabelMemberPath

  • get legendLabelMemberPath(): string
  • set legendLabelMemberPath(v: string): void
  • Gets or sets the property name that contains the legend labels.

    Returns string

  • Gets or sets the property name that contains the legend labels.

    Parameters

    • v: string

    Returns void

othersCategoryFill

  • get othersCategoryFill(): string
  • set othersCategoryFill(v: string): void
  • Gets or sets the fill brush.

    Returns string

  • Gets or sets the fill brush.

    Parameters

    • v: string

    Returns void

othersCategoryOpacity

  • get othersCategoryOpacity(): number
  • set othersCategoryOpacity(v: number): void
  • Gets or sets the opacity.

    Returns number

  • Gets or sets the opacity.

    Parameters

    • v: number

    Returns void

othersCategoryStroke

  • get othersCategoryStroke(): string
  • set othersCategoryStroke(v: string): void
  • Gets or sets the stroke brush.

    Returns string

  • Gets or sets the stroke brush.

    Parameters

    • v: string

    Returns void

othersCategoryStrokeThickness

  • get othersCategoryStrokeThickness(): number
  • set othersCategoryStrokeThickness(v: number): void
  • Gets or sets the stroke thickness.

    Returns number

  • Gets or sets the stroke thickness.

    Parameters

    • v: number

    Returns void

othersCategoryText

  • get othersCategoryText(): string
  • set othersCategoryText(v: string): void
  • Gets or sets the label of the Others slice.

    Returns string

  • Gets or sets the label of the Others slice.

    Parameters

    • v: string

    Returns void

othersCategoryThreshold

  • get othersCategoryThreshold(): number
  • set othersCategoryThreshold(v: number): void
  • Gets or sets the threshold value that determines if slices are grouped into the Others slice.

    Returns number

  • Gets or sets the threshold value that determines if slices are grouped into the Others slice.

    Parameters

    • v: number

    Returns void

othersCategoryType

  • Gets or sets whether to use numeric or percent-based threshold value.

    Returns OthersCategoryType

  • Gets or sets whether to use numeric or percent-based threshold value.

    Parameters

    Returns void

outlines

  • get outlines(): string[]
  • set outlines(v: string[]): void
  • Gets or sets the palette of brushes to use for outlines on the slices.

    Returns string[]

  • Gets or sets the palette of brushes to use for outlines on the slices.

    Parameters

    • v: string[]

    Returns void

pixelScalingRatio

  • get pixelScalingRatio(): number
  • set pixelScalingRatio(v: number): void
  • 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

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

    Parameters

    • v: number

    Returns void

radiusFactor

  • get radiusFactor(): number
  • set radiusFactor(v: number): void
  • Gets or sets the scaling factor of the chart's radius. Value between 0 and 1.

    Returns number

  • Gets or sets the scaling factor of the chart's radius. Value between 0 and 1.

    Parameters

    • v: number

    Returns void

selectedItem

  • get selectedItem(): any
  • set selectedItem(v: any): void
  • Gets or sets the currently selected data item. If a different data item is provided the pie chart will select the slice associated with the new item.

    Returns any

  • Gets or sets the currently selected data item. If a different data item is provided the pie chart will select the slice associated with the new item.

    Parameters

    • v: any

    Returns void

selectedItemChanged

  • get selectedItemChanged(): function
  • set selectedItemChanged(ev: function): void

selectedItemChanging

  • get selectedItemChanging(): function
  • set selectedItemChanging(ev: function): void

selectedItems

  • get selectedItems(): IgrObjectCollection
  • set selectedItems(v: IgrObjectCollection): void
  • Gets the currently selected data items. Adding or removing data items from this collection will select or deselect the slices associated with those items.

    Returns IgrObjectCollection

  • Gets the currently selected data items. Adding or removing data items from this collection will select or deselect the slices associated with those items.

    Parameters

    • v: IgrObjectCollection

    Returns void

selectedItemsChanged

  • get selectedItemsChanged(): function
  • set selectedItemsChanged(ev: function): void

selectedItemsChanging

  • get selectedItemsChanging(): function
  • set selectedItemsChanging(ev: function): void

selectedSliceFill

  • get selectedSliceFill(): string
  • set selectedSliceFill(v: string): void
  • Gets or sets the fill brush.

    Returns string

  • Gets or sets the fill brush.

    Parameters

    • v: string

    Returns void

selectedSliceOpacity

  • get selectedSliceOpacity(): number
  • set selectedSliceOpacity(v: number): void
  • Gets or sets the opacity.

    Returns number

  • Gets or sets the opacity.

    Parameters

    • v: number

    Returns void

selectedSliceStroke

  • get selectedSliceStroke(): string
  • set selectedSliceStroke(v: string): void
  • Gets or sets the stroke brush.

    Returns string

  • Gets or sets the stroke brush.

    Parameters

    • v: string

    Returns void

selectedSliceStrokeThickness

  • get selectedSliceStrokeThickness(): number
  • set selectedSliceStrokeThickness(v: number): void
  • Gets or sets the stroke thickness.

    Returns number

  • Gets or sets the stroke thickness.

    Parameters

    • v: number

    Returns void

selectionMode

  • Gets or sets which mode to use for selecting slices.

    Returns SliceSelectionMode

  • Gets or sets which mode to use for selecting slices.

    Parameters

    Returns void

sliceClick

  • get sliceClick(): function
  • set sliceClick(ev: function): void

startAngle

  • get startAngle(): number
  • set startAngle(v: number): void
  • Gets or sets the starting angle of the chart. The default zero value is equivalent to 3 o'clock.

    Returns number

  • Gets or sets the starting angle of the chart. The default zero value is equivalent to 3 o'clock.

    Parameters

    • v: number

    Returns void

sweepDirection

  • get sweepDirection(): SweepDirection
  • set sweepDirection(v: SweepDirection): void
  • Gets or sets the rotational direction of the chart.

    Returns SweepDirection

  • Gets or sets the rotational direction of the chart.

    Parameters

    • v: SweepDirection

    Returns void

textStyle

  • get textStyle(): string
  • set textStyle(v: string): void
  • Manually overrides the style to use for the labels.

    Returns string

  • Manually overrides the style to use for the labels.

    Parameters

    • v: string

    Returns void

toolTip

  • get toolTip(): any
  • set toolTip(v: any): void
  • Gets or sets the ToolTip for the chart.

    Returns any

  • Gets or sets the ToolTip for the chart.

    Parameters

    • v: any

    Returns void

valueMemberPath

  • get valueMemberPath(): string
  • set valueMemberPath(v: string): void
  • Gets or Sets the property name that contains the values.

    Returns string

  • Gets or Sets the property name that contains the values.

    Parameters

    • v: string

    Returns void

Methods

Optional UNSAFE_componentWillMount

  • UNSAFE_componentWillMount(): void

Optional UNSAFE_componentWillReceiveProps

  • UNSAFE_componentWillReceiveProps(nextProps: Readonly<P>, nextContext: any): void

Optional UNSAFE_componentWillUpdate

  • UNSAFE_componentWillUpdate(nextProps: Readonly<P>, nextState: Readonly<__type>, nextContext: any): void

Optional componentDidCatch

  • componentDidCatch(error: Error, errorInfo: ErrorInfo): void
  • Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.

    Parameters

    • error: Error
    • errorInfo: ErrorInfo

    Returns void

componentDidMount

  • componentDidMount(): void
  • Returns void

Optional componentDidUpdate

  • componentDidUpdate(prevProps: Readonly<P>, prevState: Readonly<__type>, snapshot?: SS): void
  • Called immediately after updating occurs. Not called for the initial render.

    The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.

    Parameters

    • prevProps: Readonly<P>
    • prevState: Readonly<__type>
    • Optional snapshot: SS

    Returns void

Optional componentWillMount

  • componentWillMount(): void

Optional componentWillReceiveProps

  • componentWillReceiveProps(nextProps: Readonly<P>, nextContext: any): void

Optional componentWillUnmount

  • componentWillUnmount(): void
  • Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as cancelled network requests, or cleaning up any DOM elements created in componentDidMount.

    Returns void

Optional componentWillUpdate

  • componentWillUpdate(nextProps: Readonly<P>, nextState: Readonly<__type>, nextContext: any): void

destroy

  • destroy(): void
  • Invoked when the instance is being destroyed.

    Returns void

ensureOthersCategoryStyle

  • ensureOthersCategoryStyle(): void
  • Returns void

ensureSelectedStyle

  • ensureSelectedStyle(): void
  • Returns void

exportSerializedVisualData

  • exportSerializedVisualData(): string
  • Returns the chart visuals expressed as a serialized string.

    Returns string

flush

  • flush(): void
  • Use to force the pie chart to finish any deferred work before printing or evaluating its visual. This should only be called if the visual of the pie chart needs to be synchronously saved or evaluated. Calling this method too often will hinder the performance of the pie chart.

    Returns void

forceUpdate

  • forceUpdate(callBack?: function): void
  • Parameters

    • Optional callBack: function
        • (): void
        • Returns void

    Returns void

Optional getSnapshotBeforeUpdate

  • getSnapshotBeforeUpdate(prevProps: Readonly<P>, prevState: Readonly<__type>): SS | null
  • Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it.

    Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running.

    Parameters

    • prevProps: Readonly<P>
    • prevState: Readonly<__type>

    Returns SS | null

notifyClearItems

  • notifyClearItems(source_: any): void
  • Manually notifies the pie chart's data source that the data it has bound to has been cleared and needs to be re-examined. This should not be called if the data that the pie chart is bound to is already observable.

    Parameters

    • source_: any
      • The data source.

    Returns void

notifyContainerResized

  • notifyContainerResized(): void
  • Notification from the containing object that the container has been resized.

    Returns void

notifyInsertItem

  • notifyInsertItem(source_: any, index: number, newItem: any): void
  • Parameters

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

    Returns void

notifyRemoveItem

  • notifyRemoveItem(source_: any, index: number, oldItem: any): void
  • Parameters

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

    Returns void

notifySetItem

  • notifySetItem(source_: any, index: number, oldItem: any, newItem: any): void
  • Parameters

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

    Returns void

provideContainer

  • provideContainer(container: any): void
  • Invoked by the containing object to provide reference to the container.

    Parameters

    • container: any
      • Reference to the container.

    Returns void

removeWidgetLevelDataSource

  • removeWidgetLevelDataSource(): void
  • Resets items data source.

    Returns void

render

  • render(): any
  • Returns any

setState

  • setState<K>(state: function | S | object, callback?: function): void
  • Type parameters

    • K: keyof __type

    Parameters

    • state: function | S | object
    • Optional callback: function
        • (): void
        • Returns void

    Returns void

setWidgetLevelDataSource

  • setWidgetLevelDataSource(source_: any): void
  • Assigns data source for the items.

    Parameters

    • source_: any
      • Array of the data source items.

    Returns void

shouldComponentUpdate

  • shouldComponentUpdate(nextProps: any, nextState: any): boolean
  • Parameters

    • nextProps: any
    • nextState: any

    Returns boolean

simulateLeftClick

  • simulateLeftClick(point: IgPoint): void
  • Simulates a mouse click action at the specified point.

    Parameters

    • point: IgPoint
      • The point to click at.

    Returns void

styleUpdated

  • styleUpdated(): void
  • Invoked when style is updated.

    Returns void

Static _createFromInternal

  • Parameters

    • internal: any

    Returns IgrPieChartBase