IgrToolPanel

new IgrToolPanel(props: IIgrToolPanelProps): IgrToolPanel

Returns IgrToolPanel

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.

actualActions: IgrToolAction<IIgrToolActionProps>[]
get accentColor(): string

Returns string

set accentColor(v: string): void

Parameters

  • v: string

Returns void

A collection of manually added style mappings for the treemap.

get actions(): IgrToolActionCollection

Returns IgrToolActionCollection

get actualAccentColor(): string

Returns string

set actualAccentColor(v: string): void

Parameters

  • v: string

Returns void

get actualBackgroundColor(): string

Returns string

set actualBackgroundColor(v: string): void

Parameters

  • v: string

Returns void

Gets the actual background color of the radio when in the checked state.

get actualCheckedBackgroundColor(): string

Returns string

set actualCheckedBackgroundColor(v: string): void

Parameters

  • v: string

Returns void

Gets the actual border color of the radio when in the checked state.

get actualCheckedBorderColor(): string

Returns string

set actualCheckedBorderColor(v: string): void

Parameters

  • v: string

Returns void

Gets the resolved display density to use for the toolbar.

get actualDensity(): ControlDisplayDensity

Returns ControlDisplayDensity

set actualDensity(v: ControlDisplayDensity): void

Parameters

  • v: ControlDisplayDensity

Returns void

get actualDisabledTextColor(): string

Returns string

set actualDisabledTextColor(v: string): void

Parameters

  • v: string

Returns void

Gets the actual dropdown delay.

get actualDropdownDelay(): number

Returns number

set actualDropdownDelay(v: number): void

Parameters

  • v: number

Returns void

get actualGroupHeaderBackgroundColor(): string

Returns string

set actualGroupHeaderBackgroundColor(v: string): void

Parameters

  • v: string

Returns void

actualGroupHeaderSeparatorBackgroundColor

Section titled "actualGroupHeaderSeparatorBackgroundColor"
get actualGroupHeaderSeparatorBackgroundColor(): string

Returns string

set actualGroupHeaderSeparatorBackgroundColor(v: string): void

Parameters

  • v: string

Returns void

get actualGroupHeaderSubtitleTextColor(): string

Returns string

set actualGroupHeaderSubtitleTextColor(v: string): void

Parameters

  • v: string

Returns void

get actualGroupHeaderTextColor(): string

Returns string

set actualGroupHeaderTextColor(v: string): void

Parameters

  • v: string

Returns void

get actualHighlightColor(): string

Returns string

set actualHighlightColor(v: string): void

Parameters

  • v: string

Returns void

get actualHighlightRadius(): number

Returns number

set actualHighlightRadius(v: number): void

Parameters

  • v: number

Returns void

get actualHighlightWidth(): number

Returns number

set actualHighlightWidth(v: number): void

Parameters

  • v: number

Returns void

get actualHoverBackgroundColor(): string

Returns string

set actualHoverBackgroundColor(v: string): void

Parameters

  • v: string

Returns void

Gets the actual icon fill color.

get actualIconFill(): string

Returns string

set actualIconFill(v: string): void

Parameters

  • v: string

Returns void

Gets the actual icon stroke color.

get actualIconStroke(): string

Returns string

set actualIconStroke(v: string): void

Parameters

  • v: string

Returns void

Gets the actual stroke color for all icon menu dropdown arrows.

get actualMenuArrowStroke(): string

Returns string

set actualMenuArrowStroke(v: string): void

Parameters

  • v: string

Returns void

Gets the actual row height used by the panel.

get actualRowHeight(): number

Returns number

get actualSeparatorBackgroundColor(): string

Returns string

set actualSeparatorBackgroundColor(v: string): void

Parameters

  • v: string

Returns void

actualSeparatorHorizontalPaddingBottom

Section titled "actualSeparatorHorizontalPaddingBottom"
get actualSeparatorHorizontalPaddingBottom(): number

Returns number

set actualSeparatorHorizontalPaddingBottom(v: number): void

Parameters

  • v: number

Returns void

actualSeparatorHorizontalPaddingLeft

Section titled "actualSeparatorHorizontalPaddingLeft"
get actualSeparatorHorizontalPaddingLeft(): number

Returns number

set actualSeparatorHorizontalPaddingLeft(v: number): void

Parameters

  • v: number

Returns void

actualSeparatorHorizontalPaddingRight

Section titled "actualSeparatorHorizontalPaddingRight"
get actualSeparatorHorizontalPaddingRight(): number

Returns number

set actualSeparatorHorizontalPaddingRight(v: number): void

Parameters

  • v: number

Returns void

actualSeparatorHorizontalPaddingTop

Section titled "actualSeparatorHorizontalPaddingTop"
get actualSeparatorHorizontalPaddingTop(): number

Returns number

set actualSeparatorHorizontalPaddingTop(v: number): void

Parameters

  • v: number

Returns void

actualSeparatorVerticalPaddingBottom

Section titled "actualSeparatorVerticalPaddingBottom"
get actualSeparatorVerticalPaddingBottom(): number

Returns number

set actualSeparatorVerticalPaddingBottom(v: number): void

Parameters

  • v: number

Returns void

get actualSeparatorVerticalPaddingLeft(): number

Returns number

set actualSeparatorVerticalPaddingLeft(v: number): void

Parameters

  • v: number

Returns void

actualSeparatorVerticalPaddingRight

Section titled "actualSeparatorVerticalPaddingRight"
get actualSeparatorVerticalPaddingRight(): number

Returns number

set actualSeparatorVerticalPaddingRight(v: number): void

Parameters

  • v: number

Returns void

get actualSeparatorVerticalPaddingTop(): number

Returns number

set actualSeparatorVerticalPaddingTop(v: number): void

Parameters

  • v: number

Returns void

get actualSubmenuBackgroundColor(): string

Returns string

set actualSubmenuBackgroundColor(v: string): void

Parameters

  • v: string

Returns void

get actualSubtitleTextColor(): string

Returns string

set actualSubtitleTextColor(v: string): void

Parameters

  • v: string

Returns void

get actualTextColor(): string

Returns string

set actualTextColor(v: string): void

Parameters

  • v: string

Returns void

Gets the actual tooltip background color.

get actualToolTipBackgroundColor(): string

Returns string

set actualToolTipBackgroundColor(v: string): void

Parameters

  • v: string

Returns void

Gets the actual tooltip corner radius.

get actualToolTipCornerRadius(): number

Returns number

set actualToolTipCornerRadius(v: number): void

Parameters

  • v: number

Returns void

Gets the actual shadow elevation used by the tooltip.

get actualToolTipElevation(): number

Returns number

set actualToolTipElevation(v: number): void

Parameters

  • v: number

Returns void

get actualToolTipTextColor(): string

Returns string

set actualToolTipTextColor(v: string): void

Parameters

  • v: string

Returns void

Gets the actual background color of the radio when in the unchecked state.

get actualUncheckedBackgroundColor(): string

Returns string

set actualUncheckedBackgroundColor(v: string): void

Parameters

  • v: string

Returns void

Gets the actual border color of the radio when in the unchecked state.

get actualUncheckedBorderColor(): string

Returns string

set actualUncheckedBorderColor(v: string): void

Parameters

  • v: string

Returns void

Gets or sets the color to use for the background of the component.

get backgroundColor(): string

Returns string

set backgroundColor(v: string): void

Parameters

  • v: string

Returns void

Gets or sets the base built in theme to use for the checkbox.

get baseTheme(): BaseControlTheme

Returns BaseControlTheme

set baseTheme(v: BaseControlTheme): void

Parameters

  • v: BaseControlTheme

Returns void

Gets or sets the text style for the panel.

get cellTextStyle(): string

Returns string

set cellTextStyle(v: string): void

Parameters

  • v: string

Returns void

Gets or sets the background color of the radio when in the checked state.

get checkedBackgroundColor(): string

Returns string

set checkedBackgroundColor(v: string): void

Parameters

  • v: string

Returns void

Gets or sets the border color of the radio when in the checked state.

get checkedBorderColor(): string

Returns string

set checkedBorderColor(v: string): void

Parameters

  • v: string

Returns void

get contentRefreshed(): object

Returns object

set contentRefreshed(ev: object): void

Parameters

  • ev: object

Returns void

Gets or sets the display density to use for the toolbar.

get density(): ControlDisplayDensity

Returns ControlDisplayDensity

set density(v: ControlDisplayDensity): void

Parameters

  • v: ControlDisplayDensity

Returns void

Gets or sets the color to use for the text in disabled tool actions.

get disabledTextColor(): string

Returns string

set disabledTextColor(v: string): void

Parameters

  • v: string

Returns void

Gets or sets the amount of time to wait when clicking on the icon menu button while the dropdown is opening. If a click was executed within this buffer window the dropdown will be left open. Otherwise it will close it. Setting a negative value will always keep the dropdown open during a hover open and will require an extra click to close.

get dropdownClickBuffer(): number

Returns number

set dropdownClickBuffer(v: number): void

Parameters

  • v: number

Returns void

Gets or sets the dropdown delay time in milliseconds.

get dropdownDelay(): number

Returns number

set dropdownDelay(v: number): void

Parameters

  • v: number

Returns void

Gets or sets the group header background color.

get groupHeaderBackgroundColor(): string

Returns string

set groupHeaderBackgroundColor(v: string): void

Parameters

  • v: string

Returns void

groupHeaderSeparatorBackgroundColor

Section titled "groupHeaderSeparatorBackgroundColor"

Gets or sets the group header separator background color.

get groupHeaderSeparatorBackgroundColor(): string

Returns string

set groupHeaderSeparatorBackgroundColor(v: string): void

Parameters

  • v: string

Returns void

Gets or sets the text color for group header subtitle.

get groupHeaderSubtitleTextColor(): string

Returns string

set groupHeaderSubtitleTextColor(v: string): void

Parameters

  • v: string

Returns void

Gets or sets the text color for group header tool actions.

get groupHeaderTextColor(): string

Returns string

set groupHeaderTextColor(v: string): void

Parameters

  • v: string

Returns void

Gets or sets the text style.

get groupHeaderTextStyle(): string

Returns string

set groupHeaderTextStyle(v: string): void

Parameters

  • v: string

Returns void

get height(): string

Returns string

set height(value: string): void

Parameters

  • value: string

Returns void

get highlightColor(): string

Returns string

set highlightColor(v: string): void

Parameters

  • v: string

Returns void

get highlightRadius(): number

Returns number

set highlightRadius(v: number): void

Parameters

  • v: number

Returns void

get highlightWidth(): number

Returns number

set highlightWidth(v: number): void

Parameters

  • v: number

Returns void

Gets or sets the hover background color.

get hoverBackgroundColor(): string

Returns string

set hoverBackgroundColor(v: string): void

Parameters

  • v: string

Returns void

get i(): ToolPanel

Returns ToolPanel

Gets or sets the fill color of icons in the ToolPanel.

get iconFill(): string

Returns string

set iconFill(v: string): void

Parameters

  • v: string

Returns void

Gets or sets the stroke color of icons in the ToolPanel.

get iconStroke(): string

Returns string

set iconStroke(v: string): void

Parameters

  • v: string

Returns void

get isOpen(): boolean

Returns boolean

Gets or sets the spacing between items

get itemSpacing(): number

Returns number

set itemSpacing(v: number): void

Parameters

  • v: number

Returns void

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

get menuArrowStroke(): string

Returns string

set menuArrowStroke(v: string): void

Parameters

  • v: string

Returns void

Gets or sets the mode used when displaying nested actions.

get nestedActionMode(): NestedActionMode

Returns NestedActionMode

set nestedActionMode(v: NestedActionMode): void

Parameters

Returns void

get onCommand(): object

Returns object

set onCommand(ev: object): void

Parameters

  • ev: object

Returns void

Gets or sets the color to use for the background of the component.

get orientation(): ToolPanelOrientation

Returns ToolPanelOrientation

set orientation(v: ToolPanelOrientation): void

Parameters

Returns void

Gets or sets the row height for the panel.

get rowHeight(): number

Returns number

set rowHeight(v: number): void

Parameters

  • v: number

Returns void

Gets or sets the style of scrollbar.

get scrollbarStyle(): ScrollbarStyle

Returns ScrollbarStyle

set scrollbarStyle(v: ScrollbarStyle): void

Parameters

  • v: ScrollbarStyle

Returns void

Gets or sets the separator background color.

get separatorBackgroundColor(): string

Returns string

set separatorBackgroundColor(v: string): void

Parameters

  • v: string

Returns void

Gets or sets the bottom padding for separators in the horizontal orientation.

get separatorHorizontalPaddingBottom(): number

Returns number

set separatorHorizontalPaddingBottom(v: number): void

Parameters

  • v: number

Returns void

Gets or sets the left padding for separators in the horizontal orientation.

get separatorHorizontalPaddingLeft(): number

Returns number

set separatorHorizontalPaddingLeft(v: number): void

Parameters

  • v: number

Returns void

Gets or sets the right padding for separators in the horizontal orientation.

get separatorHorizontalPaddingRight(): number

Returns number

set separatorHorizontalPaddingRight(v: number): void

Parameters

  • v: number

Returns void

Gets or sets the top padding for separators in the horizontal orientation.

get separatorHorizontalPaddingTop(): number

Returns number

set separatorHorizontalPaddingTop(v: number): void

Parameters

  • v: number

Returns void

Gets or sets the bottom padding for separators in the vertical orientation.

get separatorVerticalPaddingBottom(): number

Returns number

set separatorVerticalPaddingBottom(v: number): void

Parameters

  • v: number

Returns void

Gets or sets the left padding for separators in the vertical orientation.

get separatorVerticalPaddingLeft(): number

Returns number

set separatorVerticalPaddingLeft(v: number): void

Parameters

  • v: number

Returns void

Gets or sets the right padding for separators in the vertical orientation.

get separatorVerticalPaddingRight(): number

Returns number

set separatorVerticalPaddingRight(v: number): void

Parameters

  • v: number

Returns void

Gets or sets the top padding for separators in the vertical orientation.

get separatorVerticalPaddingTop(): number

Returns number

set separatorVerticalPaddingTop(v: number): void

Parameters

  • v: number

Returns void

Gets or sets if the tool actions should display their submenus on mouse hover.

get showOnHover(): boolean

Returns boolean

set showOnHover(v: boolean): void

Parameters

  • v: boolean

Returns void

Gets or sets if the tool action icon buttons should display their tooltips on mouse hover.

get showTooltipOnHover(): boolean

Returns boolean

set showTooltipOnHover(v: boolean): void

Parameters

  • v: boolean

Returns void

Prevents clicks on the tool actions from bubbling.

get stopPropagation(): boolean

Returns boolean

set stopPropagation(v: boolean): void

Parameters

  • v: boolean

Returns void

Gets or sets the background color for submenus.

get submenuBackgroundColor(): string

Returns string

set submenuBackgroundColor(v: string): void

Parameters

  • v: string

Returns void

Gets or sets the height to use for the sub panel rows if different than default.

get subPanelRowHeight(): number

Returns number

set subPanelRowHeight(v: number): void

Parameters

  • v: number

Returns void

Gets or sets the color to use for the subtitle of the component.

get subtitleTextColor(): string

Returns string

set subtitleTextColor(v: string): void

Parameters

  • v: string

Returns void

Gets or sets the subtitle text style for the panel.

get subtitleTextStyle(): string

Returns string

set subtitleTextStyle(v: string): void

Parameters

  • v: string

Returns void

Gets or sets the color to use for the text of the component.

get textColor(): string

Returns string

set textColor(v: string): void

Parameters

  • v: string

Returns void

Gets or sets the tooltip background color.

get toolTipBackgroundColor(): string

Returns string

set toolTipBackgroundColor(v: string): void

Parameters

  • v: string

Returns void

Gets or sets the tooltip corner radius.

get toolTipCornerRadius(): number

Returns number

set toolTipCornerRadius(v: number): void

Parameters

  • v: number

Returns void

Gets or sets the shadow elevation for the tooltip.

get toolTipElevation(): number

Returns number

set toolTipElevation(v: number): void

Parameters

  • v: number

Returns void

Gets or sets the tooltip text color.

get toolTipTextColor(): string

Returns string

set toolTipTextColor(v: string): void

Parameters

  • v: string

Returns void

Gets or sets the background color of the radio when in the unchecked state.

get uncheckedBackgroundColor(): string

Returns string

set uncheckedBackgroundColor(v: string): void

Parameters

  • v: string

Returns void

Gets or sets the border color of the radio when in the unchecked state.

get uncheckedBorderColor(): string

Returns string

set uncheckedBorderColor(v: string): void

Parameters

  • v: string

Returns void

get width(): string

Returns string

set width(value: string): void

Parameters

  • value: string

Returns void

Forces any open sub menus to close.

closeSubmenus(): void

Returns void

componentDidMount(): void

Returns void

componentWillUnmount(): void

Returns void

destroy(): void

Returns void

exportSerializedVisualData(): string

Returns string

exportVisualData(): any

Returns any

findByName(name: string): any

Parameters

  • name: string

Returns any

flushRefresh(): void

Returns void

getBoolContextItem(key: string): boolean

Parameters

  • key: string

Returns boolean

getBrushCollectionContextItem(key: string): string[]

Parameters

  • key: string

Returns string[]

getBrushContextItem(key: string): string

Parameters

  • key: string

Returns string

getColorContextItem(key: string): string

Parameters

  • key: string

Returns string

getDataContextItem(key: string): any

Parameters

  • key: string

Returns any

getDesiredSize(): IgSize

Returns IgSize

getDoubleContextItem(key: string): number

Parameters

  • key: string

Returns number

getIntContextItem(key: string): number

Parameters

  • key: string

Returns number

getStringContextItem(key: string): string

Parameters

  • key: string

Returns string

initializeContent(): void

Returns void

refresh(): void

Returns void

render(): DetailedReactHTMLElement<object, any>

Returns DetailedReactHTMLElement<object, any>

setBoolContextItem(key: string, value: boolean): void

Parameters

  • key: string
  • value: boolean

Returns void

setBrushCollectionContextItem(key: string, value: string[]): void

Parameters

  • key: string
  • value: string[]

Returns void

setBrushContextItem(key: string, value: string): void

Parameters

  • key: string
  • value: string

Returns void

setColorContextItem(key: string, value: string): void

Parameters

  • key: string
  • value: string

Returns void

setDataContextItem(key: string, value: any): void

Parameters

  • key: string
  • value: any

Returns void

setDoubleContextItem(key: string, value: number): void

Parameters

  • key: string
  • value: number

Returns void

setIntContextItem(key: string, value: number): void

Parameters

  • key: string
  • value: number

Returns void

setStringContextItem(key: string, value: string): void

Parameters

  • key: string
  • value: string

Returns void

shouldComponentUpdate(nextProps: any, nextState: any): boolean

Parameters

  • nextProps: any
  • nextState: any

Returns boolean

updateStyle(): void

Returns void