Class IgrRadialGaugeRange<S, SS, S>

Type parameters

  • S

  • SS

  • S

Hierarchy

Constructors

constructor

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<IIgrRadialGaugeRangeProps> & Readonly<object>

refs

refs: object

Type declaration

  • [key: string]: ReactInstance

state

state: Readonly<S>

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

brush

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

    Returns string

  • Gets or sets the brush to use to fill the range.

    Parameters

    • v: string

    Returns void

endValue

  • get endValue(): number
  • set endValue(v: number): void
  • Gets or sets the value at which the range ends along the scale.

    Returns number

  • Gets or sets the value at which the range ends along the scale.

    Parameters

    • v: number

    Returns void

i

  • get i(): XamRadialGaugeRange
  • Returns XamRadialGaugeRange

innerEndExtent

  • get innerEndExtent(): number
  • set innerEndExtent(v: number): void
  • Gets or sets the distance from the center of the gauge (from 0 to 1) at which to end rendering the inner sweep of the range. Values further from zero than 1 can be used to make this extend further than the normal radius of the gauge.

    Returns number

  • Gets or sets the distance from the center of the gauge (from 0 to 1) at which to end rendering the inner sweep of the range. Values further from zero than 1 can be used to make this extend further than the normal radius of the gauge.

    Parameters

    • v: number

    Returns void

innerStartExtent

  • get innerStartExtent(): number
  • set innerStartExtent(v: number): void
  • Gets or sets the distance from the center of the gauge (from 0 to 1) at which to start rendering the inner sweep of the range. Values further from zero than 1 can be used to make this extend further than the normal radius of the gauge.

    Returns number

  • Gets or sets the distance from the center of the gauge (from 0 to 1) at which to start rendering the inner sweep of the range. Values further from zero than 1 can be used to make this extend further than the normal radius of the gauge.

    Parameters

    • v: number

    Returns void

name

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

    Returns string

  • Gets or sets the name of the range.

    Parameters

    • v: string

    Returns void

outerEndExtent

  • get outerEndExtent(): number
  • set outerEndExtent(v: number): void
  • Gets or sets the distance from the center of the gauge (from 0 to 1) at which to end rendering the outer sweep of the range. Values further from zero than 1 can be used to make this extend further than the normal radius of the gauge.

    Returns number

  • Gets or sets the distance from the center of the gauge (from 0 to 1) at which to end rendering the outer sweep of the range. Values further from zero than 1 can be used to make this extend further than the normal radius of the gauge.

    Parameters

    • v: number

    Returns void

outerStartExtent

  • get outerStartExtent(): number
  • set outerStartExtent(v: number): void
  • Gets or sets the distance from the center of the gauge (from 0 to 1) at which to start rendering the outer sweep of the range. Values further from zero than 1 can be used to make this extend further than the normal radius of the gauge.

    Returns number

  • Gets or sets the distance from the center of the gauge (from 0 to 1) at which to start rendering the outer sweep of the range. Values further from zero than 1 can be used to make this extend further than the normal radius of the gauge.

    Parameters

    • v: number

    Returns void

outline

  • get outline(): string
  • set outline(v: string): void
  • Gets or sets the outline to use when rendering the range.

    Returns string

  • Gets or sets the outline to use when rendering the range.

    Parameters

    • v: string

    Returns void

rangeInternal

  • get rangeInternal(): XamRadialGaugeRange
  • Returns XamRadialGaugeRange

startValue

  • get startValue(): number
  • set startValue(v: number): void
  • Gets or sets the value at which the range starts along the scale.

    Returns number

  • Gets or sets the value at which the range starts along the scale.

    Parameters

    • v: number

    Returns void

strokeThickness

  • get strokeThickness(): number
  • set strokeThickness(v: number): void
  • Gets or sets the stroke thickness to use when rendering this range's outline.

    Returns number

  • Gets or sets the stroke thickness to use when rendering this range's outline.

    Parameters

    • v: number

    Returns void

Methods

Optional UNSAFE_componentWillMount

  • UNSAFE_componentWillMount(): void

Optional UNSAFE_componentWillReceiveProps

Optional UNSAFE_componentWillUpdate

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

  • 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

    Returns void

Optional componentWillMount

  • componentWillMount(): void

Optional componentWillReceiveProps

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

forceUpdate

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

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

    Returns void

Optional getSnapshotBeforeUpdate

  • 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

    Returns SS | null

render

  • render(): any
  • Returns any

setState

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

    • K: keyof S

    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 IgrRadialGaugeRange