Hierarchy

Hierarchy

Constructors

  • Parameters

    Returns IgrToolbar

Properties

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.

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<IIgrToolbarProps> & 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 actualActions(): IgrToolActionCollection
  • Gets or sets the data or data source instance to which to bind the grid.

    Returns IgrToolActionCollection

  • set actualActions(v): void
  • Parameters

    Returns void

  • get autoGeneratedActions(): IgrToolActionCollection
  • Gets or sets the data or data source instance to which to bind the grid.

    Returns IgrToolActionCollection

  • set autoGeneratedActions(v): void
  • Parameters

    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 base built in theme to use for the checkbox.

    Returns BaseControlTheme

  • set baseTheme(v): void
  • Parameters

    • v: BaseControlTheme

    Returns void

  • get cellTextStyle(): string
  • Gets or sets the text style.

    Returns string

  • set cellTextStyle(v): void
  • Parameters

    • v: string

    Returns void

  • get checkedBackgroundColor(): string
  • Gets or sets the background color of the radio when in the checked state.

    Returns string

  • set checkedBackgroundColor(v): void
  • Parameters

    • v: string

    Returns void

  • get checkedBorderColor(): string
  • Gets or sets the border color of the radio when in the checked state.

    Returns string

  • set checkedBorderColor(v): void
  • Parameters

    • v: string

    Returns void

  • get disabledTextColor(): string
  • Gets or sets the color to use for the text in disabled tool actions.

    Returns string

  • set disabledTextColor(v): void
  • Parameters

    • v: string

    Returns void

  • Gets or sets the dropdown delay time in milliseconds.

    Returns number

  • Parameters

    • v: number

    Returns void

  • get groupHeaderBackgroundColor(): string
  • Gets or sets the group header background color.

    Returns string

  • set groupHeaderBackgroundColor(v): void
  • Parameters

    • v: string

    Returns void

  • get groupHeaderSubtitleTextColor(): string
  • Gets or sets the text color for group header subtitles.

    Returns string

  • set groupHeaderSubtitleTextColor(v): void
  • Parameters

    • v: string

    Returns void

  • get groupHeaderTextColor(): string
  • Gets or sets the text color for group header tool actions.

    Returns string

  • set groupHeaderTextColor(v): void
  • Parameters

    • v: string

    Returns void

  • get height(): string
  • Returns string

  • set height(value): void
  • Parameters

    • value: string

    Returns void

  • get highlightColor(): string
  • Returns string

  • set highlightColor(v): void
  • Parameters

    • v: string

    Returns void

  • get highlightRadius(): number
  • Returns number

  • set highlightRadius(v): void
  • Parameters

    • v: number

    Returns void

  • get highlightWidth(): number
  • Returns number

  • set highlightWidth(v): void
  • Parameters

    • v: number

    Returns void

  • get hoverBackgroundColor(): string
  • Gets or sets the hover background color.

    Returns string

  • set hoverBackgroundColor(v): void
  • Parameters

    • v: string

    Returns void

  • get i(): Toolbar
  • Returns Toolbar

  • get iconFill(): string
  • Gets or sets the fill color of icons in the ToolPanel.

    Returns string

  • set iconFill(v): void
  • Parameters

    • v: string

    Returns void

  • get iconStroke(): string
  • Gets or sets the stroke color of icons in the ToolPanel.

    Returns string

  • set iconStroke(v): void
  • Parameters

    • v: string

    Returns void

  • Gets or sets the stroke color for all icon menu dropdown arrows.

    Returns string

  • Parameters

    • v: string

    Returns void

  • get onCommand(): ((s, e) => void)
  • Event raised when a command is triggered in the toolbar.

    Returns ((s, e) => void)

  • set onCommand(ev): void
  • Parameters

    Returns void

  • get orientation(): ToolbarOrientation
  • Gets or sets the orientation of the toolbar.

    Returns ToolbarOrientation

  • set orientation(v): void
  • Parameters

    Returns void

  • get rowHeight(): number
  • Gets or sets the row height that should be used.

    Returns number

  • set rowHeight(v): void
  • Parameters

    • v: number

    Returns void

  • get separatorBackgroundColor(): string
  • Gets or sets the separator background color.

    Returns string

  • set separatorBackgroundColor(v): void
  • Parameters

    • v: string

    Returns void

  • get separatorHorizontalPaddingBottom(): number
  • Gets or sets the bottom padding for separators in the horizontal orientation.

    Returns number

  • set separatorHorizontalPaddingBottom(v): void
  • Parameters

    • v: number

    Returns void

  • get separatorHorizontalPaddingLeft(): number
  • Gets or sets the left padding for separators in the horizontal orientation.

    Returns number

  • set separatorHorizontalPaddingLeft(v): void
  • Parameters

    • v: number

    Returns void

  • get separatorHorizontalPaddingRight(): number
  • Gets or sets the right padding for separators in the horizontal orientation.

    Returns number

  • set separatorHorizontalPaddingRight(v): void
  • Parameters

    • v: number

    Returns void

  • get separatorHorizontalPaddingTop(): number
  • Gets or sets the top padding for separators in the horizontal orientation.

    Returns number

  • set separatorHorizontalPaddingTop(v): void
  • Parameters

    • v: number

    Returns void

  • get separatorVerticalPaddingBottom(): number
  • Gets or sets the bottom padding for separators in the vertical orientation.

    Returns number

  • set separatorVerticalPaddingBottom(v): void
  • Parameters

    • v: number

    Returns void

  • get separatorVerticalPaddingLeft(): number
  • Gets or sets the left padding for separators in the vertical orientation.

    Returns number

  • set separatorVerticalPaddingLeft(v): void
  • Parameters

    • v: number

    Returns void

  • get separatorVerticalPaddingRight(): number
  • Gets or sets the right padding for separators in the vertical orientation.

    Returns number

  • set separatorVerticalPaddingRight(v): void
  • Parameters

    • v: number

    Returns void

  • get separatorVerticalPaddingTop(): number
  • Gets or sets the top padding for separators in the vertical orientation.

    Returns number

  • set separatorVerticalPaddingTop(v): void
  • Parameters

    • v: number

    Returns void

  • get showOnHover(): boolean
  • Gets or sets if the tool actions should display their submenus on mouse hover.

    Returns boolean

  • set showOnHover(v): void
  • Parameters

    • v: boolean

    Returns void

  • Gets or sets the background color for submenus.

    Returns string

  • Parameters

    • v: string

    Returns void

  • get subtitleTextColor(): string
  • Gets or sets the text color for subtitles.

    Returns string

  • set subtitleTextColor(v): void
  • Parameters

    • v: string

    Returns void

  • get subtitleTextStyle(): string
  • Gets or sets the text style for subtitles.

    Returns string

  • set subtitleTextStyle(v): void
  • Parameters

    • v: string

    Returns void

  • get target(): any
  • Gets or sets a target component which the toolbar can request actions from.

    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 toolTipBackgroundColor(): string
  • Gets or sets the tooltip background color.

    Returns string

  • set toolTipBackgroundColor(v): void
  • Parameters

    • v: string

    Returns void

  • get toolTipCornerRadius(): number
  • Gets or sets the tooltip corner radius.

    Returns number

  • set toolTipCornerRadius(v): void
  • Parameters

    • v: number

    Returns void

  • get toolTipElevation(): number
  • Gets or sets the shadow elevation for the tooltip.

    Returns number

  • set toolTipElevation(v): void
  • Parameters

    • v: number

    Returns void

  • get toolTipTextColor(): string
  • Gets or sets the tooltip text color.

    Returns string

  • set toolTipTextColor(v): void
  • Parameters

    • v: string

    Returns void

  • get uncheckedBackgroundColor(): string
  • Gets or sets the background color of the radio when in the unchecked state.

    Returns string

  • set uncheckedBackgroundColor(v): void
  • Parameters

    • v: string

    Returns void

  • get uncheckedBorderColor(): string
  • Gets or sets the border color of the radio when in the unchecked state.

    Returns string

  • set uncheckedBorderColor(v): void
  • Parameters

    • v: string

    Returns void

  • get width(): string
  • Returns string

  • set width(value): void
  • Parameters

    • value: string

    Returns void

Methods

  • Forces any open sub menus to close.

    Returns void

  • 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<IIgrToolbarProps>
    • prevState: Readonly<{}>
    • Optional snapshot: any

    Returns void

  • Returns void

  • Returns a serialized copy of the exported visual model

    Returns string

  • Exports visual information about the current state of the grid.

    Returns any

  • Parameters

    • name: string

    Returns any

  • Parameters

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

    Returns void

  • Parameters

    • key: string

    Returns any

  • Get the desired size the toolbar wants to be.

    Returns IgSize

  • Parameters

    • iconCollection: string
    • iconName: string

    Returns string

  • Parameters

    • iconCollection: string
    • iconName: string

    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

  • Returns void

  • Parameters

    • id: string
    • type: ToolCommandStateType
    • value: any

    Returns void

  • Parameters

    • iconCollection: string
    • iconName: string
    • iconText: string

    Returns void

  • Parameters

    • iconCollection: string
    • iconName: string
    • multiPathSVG: string[]

    Returns void

  • Returns DetailedReactHTMLElement<{
        children: any[];
        className: string;
        ref: ((ref) => void);
    }, any>

  • Parameters

    • key: string
    • value: any

    Returns void

  • 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