Represents a scale that is used determine an object's size.

Type Parameters

Hierarchy

Hierarchy

  • Component<P, {}>
    • IgrSizeScale

Constructors

Properties

context: any

If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType. Should be used with type annotation or static contextType.

static contextType = MyContext
// For TS pre-3.7:
context!: React.ContextType<typeof MyContext>
// For TS 3.7 and above:
declare context: React.ContextType<typeof MyContext>
props: Readonly<P> & Readonly<{
    children?: ReactNode;
}>
refs: {
    [key: string]: ReactInstance;
}

Type declaration

  • [key: string]: ReactInstance
state: Readonly<{}>
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}</>;
}
}

Accessors

  • get globalMaximum(): number
  • Gets or sets global maximum value that will be mapped to MaxumumValue of this scale

    Returns number

  • set globalMaximum(v): void
  • Parameters

    • v: number

    Returns void

  • get globalMinimum(): number
  • Gets or sets global minimum value that will be mapped to MinumumValue of this scale

    Returns number

  • set globalMinimum(v): void
  • Parameters

    • v: number

    Returns void

  • get isLogarithmic(): boolean
  • Gets or sets whether the scale is logarithmic.

    Returns boolean

  • set isLogarithmic(v): void
  • Parameters

    • v: boolean

    Returns void

  • get logarithmBase(): number
  • Gets or sets the logarithm base for this scale.

    Returns number

  • set logarithmBase(v): void
  • Parameters

    • v: number

    Returns void

  • get maximumValue(): number
  • Gets or sets the maximum size (in pixels) for this scale.

    Returns number

  • set maximumValue(v): void
  • Parameters

    • v: number

    Returns void

  • get minimumValue(): number
  • Gets or sets the minimum size (in pixels) for this scale.

    Returns number

  • set minimumValue(v): void
  • Parameters

    • v: number

    Returns void

  • get propertyUpdated(): ((s, e) => void)
  • Event raised when a property (including "effective" and non-dependency property) value changes.

    Returns ((s, e) => void)

      • (s, e): void
      • Event raised when a property (including "effective" and non-dependency property) value changes.

        Parameters

        Returns void

  • set propertyUpdated(ev): void
  • Parameters

    Returns void

Methods

  • Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.

    Parameters

    • error: Error
    • errorInfo: ErrorInfo

    Returns void

  • Returns 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<{}>
    • Optional snapshot: any

    Returns 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

  • Parameters

    • name: string

    Returns any

  • Parameters

    • Optional callback: (() => void)
        • (): void
        • Returns void

    Returns void

  • Returns number

  • Returns number

  • 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<{}>

    Returns any

  • Returns any

  • Type parameters

    Type Parameters

    • K extends never

    Parameters

    • state: {} | ((prevState, props) => {} | Pick<{}, K>) | Pick<{}, K>
    • Optional callback: (() => void)
        • (): void
        • Returns void

    Returns void

  • Parameters

    • nextProps: any
    • nextState: any

    Returns boolean