Hierarchy

Hierarchy

Constructors

Properties

actualProperties: IgrPropertyEditorPropertyDescription<IIgrPropertyEditorPropertyDescriptionProps>[]

The style mappings actually present in the treemap. Do not directly modify this array. This array's contents can be modified by causing React to reproject the child content. Or adding and removing ranges from the manual ranges collection on the ranges property.

contentProperties: IgrPropertyEditorPropertyDescription<IIgrPropertyEditorPropertyDescriptionProps>[]
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<IIgrPropertyEditorProps> & 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 actualDataSource(): IgrPropertyEditorPropertyDescriptionCollection
  • Gets the actaul data or data source instance to which to bind the grid.

    Returns IgrPropertyEditorPropertyDescriptionCollection

  • set actualDataSource(v): void
  • Parameters

    • v: IgrPropertyEditorPropertyDescriptionCollection

    Returns void

  • get actualDescriptionContext(): TypeDescriptionContext
  • Returns TypeDescriptionContext

  • set actualDescriptionContext(v): void
  • Parameters

    • v: TypeDescriptionContext

    Returns void

  • get backgroundColor(): string
  • Gets or sets the color to use for the background of the component.

    Returns string

  • set backgroundColor(v): void
  • Parameters

    • v: string

    Returns void

  • get baseTheme(): BaseControlTheme
  • Gets or Sets the property name that contains the values.

    Returns BaseControlTheme

  • set baseTheme(v): void
  • Parameters

    • v: BaseControlTheme

    Returns void

  • get cellTextStyle(): string
  • Gets or Sets the property name that contains the values.

    Returns string

  • set cellTextStyle(v): void
  • Parameters

    • v: string

    Returns void

  • get componentRenderer(): ComponentRenderer
  • Returns ComponentRenderer

  • set componentRenderer(v): void
  • Parameters

    • v: ComponentRenderer

    Returns void

  • get density(): ControlDisplayDensity
  • Gets or Sets the property name that contains the values.

    Returns ControlDisplayDensity

  • set density(v): void
  • Parameters

    • v: ControlDisplayDensity

    Returns void

  • get descriptionContext(): TypeDescriptionContext
  • Returns TypeDescriptionContext

  • set descriptionContext(v): void
  • Parameters

    • v: TypeDescriptionContext

    Returns void

  • get descriptionType(): string
  • Returns string

  • set descriptionType(v): void
  • Parameters

    • v: string

    Returns void

  • get filterPlaceholderText(): string
  • Gets or Sets the property name that contains the values.

    Returns string

  • set filterPlaceholderText(v): void
  • Parameters

    • v: string

    Returns void

  • get height(): string
  • Returns string

  • set height(value): void
  • Parameters

    • value: string

    Returns void

  • get i(): PropertyEditor
  • Returns PropertyEditor

  • get isHorizontal(): boolean
  • Returns boolean

  • set isHorizontal(v): void
  • Parameters

    • v: boolean

    Returns void

  • get isIndirectModeEnabled(): boolean
  • Returns boolean

  • set isIndirectModeEnabled(v): void
  • Parameters

    • v: boolean

    Returns void

  • get isWrappingEnabled(): boolean
  • Returns boolean

  • set isWrappingEnabled(v): void
  • Parameters

    • v: boolean

    Returns void

  • get properties(): IgrPropertyEditorPropertyDescriptionCollection
  • A collection of manually added style mappings for the treemap.

    Returns IgrPropertyEditorPropertyDescriptionCollection

  • get rowHeight(): number
  • Gets or Sets the property name that contains the values.

    Returns number

  • set rowHeight(v): void
  • Parameters

    • v: number

    Returns void

  • get searchInputType(): InputGroupDisplayType
  • Gets or Sets the property name that contains the values.

    Returns InputGroupDisplayType

  • set searchInputType(v): void
  • Parameters

    • v: InputGroupDisplayType

    Returns void

  • get target(): any
  • Returns any

  • set target(v): void
  • Parameters

    • v: any

    Returns void

  • get textColor(): string
  • Gets or sets the color to use for the text of the component.

    Returns string

  • set textColor(v): void
  • Parameters

    • v: string

    Returns void

  • get width(): string
  • Returns string

  • set width(value): void
  • Parameters

    • value: string

    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

    Returns void

  • Returns void

  • Parameters

    • name: string

    Returns any

  • Parameters

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

    Returns void

  • Returns IgSize

  • 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

  • Returns void

  • Manually notifies the checkboxlist's grid that the data it has bound to has been cleared and needs to be re-examined. This should not be called if the data that the grid is bound to is already observable.

    Returns void

  • Parameters

    • index: number
    • newItem: any

    Returns void

  • Parameters

    • index: number
    • oldItem: any

    Returns void

  • Parameters

    • index: number
    • oldItem: any
    • newItem: any

    Returns void

  • Returns DetailedReactHTMLElement<{
        children: any[];
        className: string;
        ref: ((ref) => void);
    }, 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

  • Returns void