Provides a pre-configured column hiding component for the grid.

Igx Module

IgxGridToolbarModule

Igx Parent

IgxGridToolbarComponent

Example


Type Parameters

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<P & Omit<HTMLAttributes<HTMLElement>, keyof 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 closed(): ((s, e) => void)
  • Emits an event after the toggle container is closed.

    Returns ((s, e) => void)

  • set closed(ev): void
  • Parameters

    Returns void

  • get closing(): ((s, e) => void)
  • Emits an event before the toggle container is closed.

    Returns ((s, e) => void)

  • set closing(ev): void
  • Parameters

    Returns void

  • get columnListHeight(): string
  • Sets the height of the column list in the dropdown.

    Returns string

  • set columnListHeight(v): void
  • Parameters

    • v: string

    Returns void

  • get columnToggle(): ((s, e) => void)
  • Emits when after a column's checked state is changed

    Returns ((s, e) => void)

  • set columnToggle(ev): void
  • Parameters

    Returns void

  • get name(): string
  • Returns string

  • set name(v): void
  • Parameters

    • v: string

    Returns void

  • get nativeElement(): HTMLElement
  • Returns HTMLElement

  • get opened(): ((s, e) => void)
  • Emits an event after the toggle container is opened.

    Returns ((s, e) => void)

  • set opened(ev): void
  • Parameters

    Returns void

  • get opening(): ((s, e) => void)
  • Emits an event before the toggle container is opened.

    Returns ((s, e) => void)

  • set opening(ev): void
  • Parameters

    Returns void

  • get overlaySettings(): IgrOverlaySettings
  • Sets overlay settings

    Returns IgrOverlaySettings

  • set overlaySettings(v): void
  • Parameters

    Returns void

  • get prompt(): string
  • The placeholder text for the search input.

    Returns string

  • set prompt(v): void
  • Parameters

    • v: string

    Returns void

  • get title(): string
  • Title text for the column action component

    Returns string

  • set title(v): void
  • Parameters

    • v: 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

  • 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 & Omit<HTMLAttributes<HTMLElement>, keyof 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

  • 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 & Omit<HTMLAttributes<HTMLElement>, keyof P>>
    • prevState: Readonly<{}>

    Returns any

  • Returns DetailedReactHTMLElement<any, HTMLElement>

  • Type parameters

    Type Parameters

    • K extends never

    Parameters

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

    Returns void