Represents a brush scale that uses value-based brush selection.

Hierarchy

Hierarchy

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<IIgrValueBrushScaleProps> & 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 brushes(): string[]
  • Gets the brushes collection used by this scale.

    Returns string[]

  • set brushes(v): void
  • Parameters

    • v: string[]

    Returns void

  • get isBrushScale(): boolean
  • Checks if this item is a BrushScale

    Returns boolean

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

    Returns boolean

  • set isLogarithmic(v): void
  • Parameters

    • v: boolean

    Returns void

  • get isReady(): boolean
  • Checks if the value brush scale is ready for usage in the chart

    Returns boolean

  • 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 value for this scale.

    Returns number

  • set maximumValue(v): void
  • Parameters

    • v: number

    Returns void

  • get minimumValue(): number
  • Gets or sets the minimum value 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

  • 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

  • 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

  • Gets a brush from the brushes collection by index.

    Parameters

    • index: number

    Returns string

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

  • Notify attached series about changes to this scale

    Returns void

  • Registers a series with the scale. Under normal circumstances you should not need to call this manually.

    Parameters

    Returns void

  • 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

  • Unregisters a series with the scale. Under normal circumstances you should not need to call this manually.

    Parameters

    Returns void