Class IgrStackedFragmentSeries<P, SS>

Represents a non-visual child of StackedSeriesBase.

Type parameters

Hierarchy

  • Component<P, __type>
    • IgrStackedFragmentSeries

Constructors

constructor

  • Parameters

    • props: P

    Returns IgrStackedFragmentSeries

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

actualAreaFillOpacity

  • get actualAreaFillOpacity(): number
  • set actualAreaFillOpacity(v: number): void
  • Gets the series ActualAreaFillOpacity. This property only applies for area-like series.

    Returns number

  • Gets the series ActualAreaFillOpacity. This property only applies for area-like series.

    Parameters

    • v: number

    Returns void

actualBrush

  • get actualBrush(): string
  • set actualBrush(v: string): void
  • Gets the actual brush used by the series.

    Returns string

  • Gets the actual brush used by the series.

    Parameters

    • v: string

    Returns void

actualIsDropShadowEnabled

  • get actualIsDropShadowEnabled(): boolean
  • set actualIsDropShadowEnabled(v: boolean): void
  • Gets whether drop shadow is actually enabled for this series.

    Returns boolean

  • Gets whether drop shadow is actually enabled for this series.

    Parameters

    • v: boolean

    Returns void

actualLegendItemBadgeTemplate

  • get actualLegendItemBadgeTemplate(): IgDataTemplate
  • set actualLegendItemBadgeTemplate(v: IgDataTemplate): void
  • Gets the actual legend item badge template used by the series.

    Returns IgDataTemplate

  • Gets the actual legend item badge template used by the series.

    Parameters

    • v: IgDataTemplate

    Returns void

actualLegendItemTemplate

  • get actualLegendItemTemplate(): IgDataTemplate
  • set actualLegendItemTemplate(v: IgDataTemplate): void
  • Gets the actual legend item template used by the series.

    Returns IgDataTemplate

  • Gets the actual legend item template used by the series.

    Parameters

    • v: IgDataTemplate

    Returns void

actualLegendItemVisibility

  • get actualLegendItemVisibility(): Visibility
  • set actualLegendItemVisibility(v: Visibility): void
  • Gets the actual visibility of the legend items in the series.

    Returns Visibility

  • Gets the actual visibility of the legend items in the series.

    Parameters

    • v: Visibility

    Returns void

actualMarkerBrush

  • get actualMarkerBrush(): string
  • set actualMarkerBrush(v: string): void
  • Gets the actual marker brush of the series.

    Returns string

  • Gets the actual marker brush of the series.

    Parameters

    • v: string

    Returns void

actualMarkerOutline

  • get actualMarkerOutline(): string
  • set actualMarkerOutline(v: string): void
  • Gets the actual marker outline of the series.

    Returns string

  • Gets the actual marker outline of the series.

    Parameters

    • v: string

    Returns void

actualMarkerTemplate

  • get actualMarkerTemplate(): IgDataTemplate
  • set actualMarkerTemplate(v: IgDataTemplate): void
  • Gets the actual marker template used by the series.

    Returns IgDataTemplate

  • Gets the actual marker template used by the series.

    Parameters

    • v: IgDataTemplate

    Returns void

actualMarkerType

  • Gets the actual marker type set used in the series.

    Returns MarkerType

  • Gets the actual marker type set used in the series.

    Parameters

    Returns void

actualOpacity

  • get actualOpacity(): number
  • set actualOpacity(v: number): void
  • Gets the series opacity.

    Returns number

  • Gets the series opacity.

    Parameters

    • v: number

    Returns void

actualOutline

  • get actualOutline(): string
  • set actualOutline(v: string): void
  • Gets the series outline.

    Returns string

  • Gets the series outline.

    Parameters

    • v: string

    Returns void

actualRadiusX

  • get actualRadiusX(): number
  • set actualRadiusX(v: number): void
  • Gets the actual corner radius of the series

    Returns number

  • Gets the actual corner radius of the series

    Parameters

    • v: number

    Returns void

actualRadiusY

  • get actualRadiusY(): number
  • set actualRadiusY(v: number): void
  • Gets the actual corner radius of the series

    Returns number

  • Gets the actual corner radius of the series

    Parameters

    • v: number

    Returns void

actualShadowBlur

  • get actualShadowBlur(): number
  • set actualShadowBlur(v: number): void
  • Gets the actual shadow blur used by the series.

    Returns number

  • Gets the actual shadow blur used by the series.

    Parameters

    • v: number

    Returns void

actualShadowColor

  • get actualShadowColor(): string
  • set actualShadowColor(v: string): void
  • Gets actual the drop shadow color used by the series.

    Returns string

  • Gets actual the drop shadow color used by the series.

    Parameters

    • v: string

    Returns void

actualShadowOffsetX

  • get actualShadowOffsetX(): number
  • set actualShadowOffsetX(v: number): void
  • Gets the actual drop shadow x-offset applied to the series.

    Returns number

  • Gets the actual drop shadow x-offset applied to the series.

    Parameters

    • v: number

    Returns void

actualShadowOffsetY

  • get actualShadowOffsetY(): number
  • set actualShadowOffsetY(v: number): void
  • Gets the actual drop shadow y-offset applied to the series.

    Returns number

  • Gets the actual drop shadow y-offset applied to the series.

    Parameters

    • v: number

    Returns void

actualThickness

  • get actualThickness(): number
  • set actualThickness(v: number): void
  • Gets or sets the thickness of this stacked fragment.

    Returns number

  • Gets or sets the thickness of this stacked fragment.

    Parameters

    • v: number

    Returns void

actualUseSingleShadow

  • get actualUseSingleShadow(): boolean
  • set actualUseSingleShadow(v: boolean): void
  • Gets whether drop shadow is actually applied to the whole StackedFragmentSeries visual or to each of the individual shapes forming the StackedFragmentSeries.

    Returns boolean

  • Gets whether drop shadow is actually applied to the whole StackedFragmentSeries visual or to each of the individual shapes forming the StackedFragmentSeries.

    Parameters

    • v: boolean

    Returns void

actualVisibility

  • get actualVisibility(): Visibility
  • set actualVisibility(v: Visibility): void
  • Gets the actual visibility of the stacked fragment.

    Returns Visibility

  • Gets the actual visibility of the stacked fragment.

    Parameters

    • v: Visibility

    Returns void

areaFillOpacity

  • get areaFillOpacity(): number
  • set areaFillOpacity(v: number): void
  • Gets or sets the AreaFillOpacity of the stacked fragment. This property only applies for area-like series.

    Returns number

  • Gets or sets the AreaFillOpacity of the stacked fragment. This property only applies for area-like series.

    Parameters

    • v: number

    Returns void

brush

  • get brush(): string
  • set brush(v: string): void
  • Gets or sets the brush of the stacked fragment.

    Returns string

  • Gets or sets the brush of the stacked fragment.

    Parameters

    • v: string

    Returns void

isDropShadowEnabled

  • get isDropShadowEnabled(): boolean
  • set isDropShadowEnabled(v: boolean): void
  • Gets or sets whether drop shadow should be enabled for this series.

    Returns boolean

  • Gets or sets whether drop shadow should be enabled for this series.

    Parameters

    • v: boolean

    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 series object itself.

    Returns IgDataTemplate

  • Gets or sets the LegendItemBadgeTemplate property. The legend item badge is created according to the LegendItemBadgeTemplate on-demand by the series 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 series 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 series object itself.

    Parameters

    • v: IgDataTemplate

    Returns void

legendItemVisibility

  • get legendItemVisibility(): Visibility
  • set legendItemVisibility(v: Visibility): void
  • Gets or sets the legend item visibility for the current series object.

    Returns Visibility

  • Gets or sets the legend item visibility for the current series object.

    Parameters

    • v: Visibility

    Returns void

markerBrush

  • get markerBrush(): string
  • set markerBrush(v: string): void
  • Gets or sets the brush that specifies how the current series object's marker interiors are painted.

    Returns string

  • Gets or sets the brush that specifies how the current series object's marker interiors are painted.

    Parameters

    • v: string

    Returns void

markerOutline

  • get markerOutline(): string
  • set markerOutline(v: string): void
  • Gets or sets the brush that specifies how the current series object's marker outlines are painted.

    Returns string

  • Gets or sets the brush that specifies how the current series object's marker outlines are painted.

    Parameters

    • v: string

    Returns void

markerTemplate

  • get markerTemplate(): IgDataTemplate
  • set markerTemplate(v: IgDataTemplate): void
  • Gets or sets the MarkerTemplate for the current series object.

    Returns IgDataTemplate

  • Gets or sets the MarkerTemplate for the current series object.

    Parameters

    • v: IgDataTemplate

    Returns void

markerType

  • Gets or sets the marker type for the current series object. If the MarkerTemplate property is set, the setting of the MarkerType property will be ignored.

    Returns MarkerType

  • Gets or sets the marker type for the current series object. If the MarkerTemplate property is set, the setting of the MarkerType property will be ignored.

    Parameters

    Returns void

name

  • get name(): string
  • set name(v: string): void
  • Gets or sets the Name of the stacked fragment.

    Returns string

  • Gets or sets the Name of the stacked fragment.

    Parameters

    • v: string

    Returns void

opacity

  • get opacity(): number
  • set opacity(v: number): void
  • Gets or sets the Opacity of the stacked fragment.

    Returns number

  • Gets or sets the Opacity of the stacked fragment.

    Parameters

    • v: number

    Returns void

outline

  • get outline(): string
  • set outline(v: string): void
  • Gets or sets the brush to use for the outline of the series. Some series types, such as LineSeries, do not display outlines. Therefore, this property does not affect some charts.

    Returns string

  • Gets or sets the brush to use for the outline of the series. Some series types, such as LineSeries, do not display outlines. Therefore, this property does not affect some charts.

    Parameters

    • v: string

    Returns void

parentOrLocalBrush

  • get parentOrLocalBrush(): string
  • set parentOrLocalBrush(v: string): void
  • Gets the resolved brush used between the local series and the parent series.

    Returns string

  • Gets the resolved brush used between the local series and the parent series.

    Parameters

    • v: string

    Returns void

propertyUpdated

  • get propertyUpdated(): function
  • set propertyUpdated(ev: function): void
  • Event raised when a property (including "effective" and non-dependency property) value changes.

    Returns function

  • Event raised when a property (including "effective" and non-dependency property) value changes.

    Parameters

    Returns void

radiusX

  • get radiusX(): number
  • set radiusX(v: number): void
  • Gets or sets the x-radius of the ellipse that is used to round the corners of the column. This only applies to Bar and Column series.

    Returns number

  • Gets or sets the x-radius of the ellipse that is used to round the corners of the column. This only applies to Bar and Column series.

    Parameters

    • v: number

    Returns void

radiusY

  • get radiusY(): number
  • set radiusY(v: number): void
  • Gets or sets the y-radius of the ellipse that is used to round the corners of the column. This only applies to Bar and Column series.

    Returns number

  • Gets or sets the y-radius of the ellipse that is used to round the corners of the column. This only applies to Bar and Column series.

    Parameters

    • v: number

    Returns void

shadowBlur

  • get shadowBlur(): number
  • set shadowBlur(v: number): void
  • Gets or sets the shadow blur. This property is ignored when StackedFragmentSeries.UseSingleShadow is set to true.

    Returns number

  • Gets or sets the shadow blur. This property is ignored when StackedFragmentSeries.UseSingleShadow is set to true.

    Parameters

    • v: number

    Returns void

shadowColor

  • get shadowColor(): string
  • set shadowColor(v: string): void
  • Gets or sets the drop shadow color.

    Returns string

  • Gets or sets the drop shadow color.

    Parameters

    • v: string

    Returns void

shadowOffsetX

  • get shadowOffsetX(): number
  • set shadowOffsetX(v: number): void
  • Gets or sets the drop shadow x-offset.

    Returns number

  • Gets or sets the drop shadow x-offset.

    Parameters

    • v: number

    Returns void

shadowOffsetY

  • get shadowOffsetY(): number
  • set shadowOffsetY(v: number): void
  • Gets or sets the drop shadow y-offset.

    Returns number

  • Gets or sets the drop shadow y-offset.

    Parameters

    • v: number

    Returns void

thickness

  • get thickness(): number
  • set thickness(v: number): void
  • Gets or sets the width of the current series object's line thickness.

    Returns number

  • Gets or sets the width of the current series object's line thickness.

    Parameters

    • v: number

    Returns void

title

  • get title(): any
  • set title(v: any): void
  • Gets or sets the Title property. The legend item control is created according to the Title on-demand by the series object itself.

    Returns any

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

    Parameters

    • v: any

    Returns void

useSingleShadow

  • get useSingleShadow(): boolean
  • set useSingleShadow(v: boolean): void
  • Gets or sets whether drop shadow is applied to the whole StackedFragmentSeries visual or to each of the individual shapes forming the StackedFragmentSeries. When this property is set to true, no StackedFragmentSeries.ShadowBlur is applied.

    Returns boolean

  • Gets or sets whether drop shadow is applied to the whole StackedFragmentSeries visual or to each of the individual shapes forming the StackedFragmentSeries. When this property is set to true, no StackedFragmentSeries.ShadowBlur is applied.

    Parameters

    • v: boolean

    Returns void

valueMemberPath

  • get valueMemberPath(): string
  • set valueMemberPath(v: string): void
  • Gets or sets the value mapping property for the current series object.

    Returns string

  • Gets or sets the value mapping property for the current series object.

    Parameters

    • v: string

    Returns void

visibility

  • get visibility(): Visibility
  • set visibility(v: Visibility): void
  • Gets or sets the Visibility of the stacked fragment.

    Returns Visibility

  • Gets or sets the Visibility of the stacked fragment.

    Parameters

    • v: Visibility

    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

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

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

shouldComponentUpdate

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

    • nextProps: any
    • nextState: any

    Returns boolean

Static _createFromInternal

  • Parameters

    • internal: any

    Returns IgrStackedFragmentSeries