Class IgrZoomSlider<S, SS, S>

Type parameters

  • S

  • SS

  • S

Hierarchy

Constructors

Properties

Accessors

Methods

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<IIgrZoomSliderProps> & 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

actualPixelScalingRatio

  • get actualPixelScalingRatio(): number
  • set actualPixelScalingRatio(v: number): void
  • Returns number

  • Parameters

    • v: number

    Returns void

areThumbCalloutsEnabled

  • get areThumbCalloutsEnabled(): boolean
  • set areThumbCalloutsEnabled(v: boolean): void
  • Returns boolean

  • Parameters

    • v: boolean

    Returns void

barBrush

  • get barBrush(): string
  • set barBrush(v: string): void
  • Returns string

  • Parameters

    • v: string

    Returns void

barExtent

  • get barExtent(): number
  • set barExtent(v: number): void
  • Returns number

  • Parameters

    • v: number

    Returns void

barOutline

  • get barOutline(): string
  • set barOutline(v: string): void
  • Returns string

  • Parameters

    • v: string

    Returns void

barStrokeThickness

  • get barStrokeThickness(): number
  • set barStrokeThickness(v: number): void
  • Returns number

  • Parameters

    • v: number

    Returns void

endInset

  • get endInset(): number
  • set endInset(v: number): void
  • Returns number

  • Parameters

    • v: number

    Returns void

height

  • get height(): string
  • set height(value: string): void
  • Returns string

  • Parameters

    • value: string

    Returns void

higherCalloutBrush

  • get higherCalloutBrush(): string
  • set higherCalloutBrush(v: string): void
  • Returns string

  • Parameters

    • v: string

    Returns void

higherCalloutOutline

  • get higherCalloutOutline(): string
  • set higherCalloutOutline(v: string): void
  • Returns string

  • Parameters

    • v: string

    Returns void

higherCalloutStrokeThickness

  • get higherCalloutStrokeThickness(): number
  • set higherCalloutStrokeThickness(v: number): void
  • Returns number

  • Parameters

    • v: number

    Returns void

higherCalloutTextColor

  • get higherCalloutTextColor(): string
  • set higherCalloutTextColor(v: string): void
  • Returns string

  • Parameters

    • v: string

    Returns void

higherShadeBrush

  • get higherShadeBrush(): string
  • set higherShadeBrush(v: string): void
  • Returns string

  • Parameters

    • v: string

    Returns void

higherShadeOutline

  • get higherShadeOutline(): string
  • set higherShadeOutline(v: string): void
  • Returns string

  • Parameters

    • v: string

    Returns void

higherShadeStrokeThickness

  • get higherShadeStrokeThickness(): number
  • set higherShadeStrokeThickness(v: number): void
  • Returns number

  • Parameters

    • v: number

    Returns void

higherThumbBrush

  • get higherThumbBrush(): string
  • set higherThumbBrush(v: string): void
  • Returns string

  • Parameters

    • v: string

    Returns void

higherThumbHeight

  • get higherThumbHeight(): number
  • set higherThumbHeight(v: number): void
  • Returns number

  • Parameters

    • v: number

    Returns void

higherThumbOutline

  • get higherThumbOutline(): string
  • set higherThumbOutline(v: string): void
  • Returns string

  • Parameters

    • v: string

    Returns void

higherThumbRidgesBrush

  • get higherThumbRidgesBrush(): string
  • set higherThumbRidgesBrush(v: string): void
  • Returns string

  • Parameters

    • v: string

    Returns void

higherThumbStrokeThickness

  • get higherThumbStrokeThickness(): number
  • set higherThumbStrokeThickness(v: number): void
  • Returns number

  • Parameters

    • v: number

    Returns void

higherThumbWidth

  • get higherThumbWidth(): number
  • set higherThumbWidth(v: number): void
  • Returns number

  • Parameters

    • v: number

    Returns void

i

  • get i(): ZoomSlider
  • Returns ZoomSlider

isCustomBarProvided

  • get isCustomBarProvided(): boolean
  • Returns boolean

isCustomRangeThumbProvided

  • get isCustomRangeThumbProvided(): boolean
  • Returns boolean

isCustomShadeProvided

  • get isCustomShadeProvided(): boolean
  • Returns boolean

isCustomThumbProvided

  • get isCustomThumbProvided(): boolean
  • Returns boolean

lowerCalloutBrush

  • get lowerCalloutBrush(): string
  • set lowerCalloutBrush(v: string): void
  • Returns string

  • Parameters

    • v: string

    Returns void

lowerCalloutOutline

  • get lowerCalloutOutline(): string
  • set lowerCalloutOutline(v: string): void
  • Returns string

  • Parameters

    • v: string

    Returns void

lowerCalloutStrokeThickness

  • get lowerCalloutStrokeThickness(): number
  • set lowerCalloutStrokeThickness(v: number): void
  • Returns number

  • Parameters

    • v: number

    Returns void

lowerCalloutTextColor

  • get lowerCalloutTextColor(): string
  • set lowerCalloutTextColor(v: string): void
  • Returns string

  • Parameters

    • v: string

    Returns void

lowerShadeBrush

  • get lowerShadeBrush(): string
  • set lowerShadeBrush(v: string): void
  • Returns string

  • Parameters

    • v: string

    Returns void

lowerShadeOutline

  • get lowerShadeOutline(): string
  • set lowerShadeOutline(v: string): void
  • Returns string

  • Parameters

    • v: string

    Returns void

lowerShadeStrokeThickness

  • get lowerShadeStrokeThickness(): number
  • set lowerShadeStrokeThickness(v: number): void
  • Returns number

  • Parameters

    • v: number

    Returns void

lowerThumbBrush

  • get lowerThumbBrush(): string
  • set lowerThumbBrush(v: string): void
  • Returns string

  • Parameters

    • v: string

    Returns void

lowerThumbHeight

  • get lowerThumbHeight(): number
  • set lowerThumbHeight(v: number): void
  • Returns number

  • Parameters

    • v: number

    Returns void

lowerThumbOutline

  • get lowerThumbOutline(): string
  • set lowerThumbOutline(v: string): void
  • Returns string

  • Parameters

    • v: string

    Returns void

lowerThumbRidgesBrush

  • get lowerThumbRidgesBrush(): string
  • set lowerThumbRidgesBrush(v: string): void
  • Returns string

  • Parameters

    • v: string

    Returns void

lowerThumbStrokeThickness

  • get lowerThumbStrokeThickness(): number
  • set lowerThumbStrokeThickness(v: number): void
  • Returns number

  • Parameters

    • v: number

    Returns void

lowerThumbWidth

  • get lowerThumbWidth(): number
  • set lowerThumbWidth(v: number): void
  • Returns number

  • Parameters

    • v: number

    Returns void

maxZoomWidth

  • get maxZoomWidth(): number
  • set maxZoomWidth(v: number): void
  • Returns number

  • Parameters

    • v: number

    Returns void

minZoomWidth

  • get minZoomWidth(): number
  • set minZoomWidth(v: number): void
  • Returns number

  • Parameters

    • v: number

    Returns void

orientation

panTransitionDuration

  • get panTransitionDuration(): number
  • set panTransitionDuration(v: number): void
  • Returns number

  • Parameters

    • v: number

    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

rangeThumbBrush

  • get rangeThumbBrush(): string
  • set rangeThumbBrush(v: string): void
  • Returns string

  • Parameters

    • v: string

    Returns void

rangeThumbOutline

  • get rangeThumbOutline(): string
  • set rangeThumbOutline(v: string): void
  • Returns string

  • Parameters

    • v: string

    Returns void

rangeThumbRidgesBrush

  • get rangeThumbRidgesBrush(): string
  • set rangeThumbRidgesBrush(v: string): void
  • Returns string

  • Parameters

    • v: string

    Returns void

rangeThumbStrokeThickness

  • get rangeThumbStrokeThickness(): number
  • set rangeThumbStrokeThickness(v: number): void
  • Returns number

  • Parameters

    • v: number

    Returns void

resolvingAxisValue

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

startInset

  • get startInset(): number
  • set startInset(v: number): void
  • Returns number

  • Parameters

    • v: number

    Returns void

thumbCalloutTextStyle

  • get thumbCalloutTextStyle(): string
  • set thumbCalloutTextStyle(v: string): void
  • Returns string

  • Parameters

    • v: string

    Returns void

trackEndInset

  • get trackEndInset(): number
  • set trackEndInset(v: number): void
  • Returns number

  • Parameters

    • v: number

    Returns void

trackStartInset

  • get trackStartInset(): number
  • set trackStartInset(v: number): void
  • Returns number

  • Parameters

    • v: number

    Returns void

width

  • get width(): string
  • set width(value: string): void
  • Returns string

  • Parameters

    • value: string

    Returns void

windowRect

  • get windowRect(): IgRect
  • set windowRect(v: IgRect): void
  • Returns IgRect

  • Parameters

    • v: IgRect

    Returns void

windowRectChanged

  • get windowRectChanged(): function
  • set windowRectChanged(ev: function): void
  • Occurs just after the current ZoomSlider's window rectangle is changed.

    Returns function

  • Occurs just after the current ZoomSlider's window rectangle is changed.

    Parameters

    • ev: function

    Returns void

Methods

Optional UNSAFE_componentWillMount

  • UNSAFE_componentWillMount(): void

Optional UNSAFE_componentWillReceiveProps

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

Optional UNSAFE_componentWillUpdate

  • UNSAFE_componentWillUpdate(nextProps: Readonly<IIgrZoomSliderProps>, nextState: Readonly<S>, 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<IIgrZoomSliderProps>, prevState: Readonly<S>, 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

    Returns void

Optional componentWillMount

  • componentWillMount(): void

Optional componentWillReceiveProps

componentWillUnmount

  • componentWillUnmount(): void
  • Returns void

Optional componentWillUpdate

  • componentWillUpdate(nextProps: Readonly<IIgrZoomSliderProps>, nextState: Readonly<S>, nextContext: any): void

destroy

  • destroy(): void
  • Release any resources held by the ZoomSlider.

    Returns void

flush

  • flush(): void
  • Returns void

forceUpdate

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

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

    Returns void

Optional getSnapshotBeforeUpdate

  • getSnapshotBeforeUpdate(prevProps: Readonly<IIgrZoomSliderProps>, prevState: Readonly<S>): 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

    Returns SS | null

hide

  • hide(): void
  • Hides the ZoomSlider.

    Returns void

initializeContent

  • initializeContent(): void
  • Returns void

onAttachedToUI

  • onAttachedToUI(): void
  • Returns void

onDetachedFromUI

  • onDetachedFromUI(): void
  • Returns void

provideContainer

  • provideContainer(container: any): void
  • Called by the UI framework to provide a UI container for rendering this control.

    Parameters

    • container: any
      • The UI container element.

    Returns void

render

  • render(): DetailedReactHTMLElement<object, any>
  • Returns DetailedReactHTMLElement<object, 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

show

  • show(): void
  • Shows the ZoomSlider.

    Returns void

trackDirty

  • trackDirty(): void
  • Returns void

updateStyle

  • updateStyle(): void
  • Returns void