Constructors

Section titled "Constructors"

IgrToolPanel

new IgrToolPanel(props: IIgrToolPanelProps): IgrToolPanel

Returns IgrToolPanel

Properties

Section titled "Properties"

actualActions

Section titled "actualActions"

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>[]

contentActions

Section titled "contentActions" 
contentActions: IgrToolAction<IIgrToolActionProps>[]

accentColor

Section titled "accentColor" 
accentColor: string

actualAccentColor

Section titled "actualAccentColor" 
actualAccentColor: string

actualBackgroundColor

Section titled "actualBackgroundColor" 
actualBackgroundColor: string

actualCheckedBackgroundColor

Section titled "actualCheckedBackgroundColor" 
actualCheckedBackgroundColor: string

actualCheckedBorderColor

Section titled "actualCheckedBorderColor" 
actualCheckedBorderColor: string

actualDensity

Section titled "actualDensity" 
actualDensity: ControlDisplayDensity

actualDisabledTextColor

Section titled "actualDisabledTextColor" 
actualDisabledTextColor: string

actualDropdownDelay

Section titled "actualDropdownDelay" 
actualDropdownDelay: number

actualGroupHeaderBackgroundColor

Section titled "actualGroupHeaderBackgroundColor" 
actualGroupHeaderBackgroundColor: string

actualGroupHeaderSeparatorBackgroundColor

Section titled "actualGroupHeaderSeparatorBackgroundColor" 
actualGroupHeaderSeparatorBackgroundColor: string

actualGroupHeaderSubtitleTextColor

Section titled "actualGroupHeaderSubtitleTextColor" 
actualGroupHeaderSubtitleTextColor: string

actualGroupHeaderTextColor

Section titled "actualGroupHeaderTextColor" 
actualGroupHeaderTextColor: string

actualHighlightColor

Section titled "actualHighlightColor" 
actualHighlightColor: string

actualHighlightRadius

Section titled "actualHighlightRadius" 
actualHighlightRadius: number

actualHighlightWidth

Section titled "actualHighlightWidth" 
actualHighlightWidth: number

actualHoverBackgroundColor

Section titled "actualHoverBackgroundColor" 
actualHoverBackgroundColor: string

actualIconFill

Section titled "actualIconFill" 
actualIconFill: string

actualIconStroke

Section titled "actualIconStroke" 
actualIconStroke: string

actualMenuArrowStroke

Section titled "actualMenuArrowStroke" 
actualMenuArrowStroke: string

actualSeparatorBackgroundColor

Section titled "actualSeparatorBackgroundColor" 
actualSeparatorBackgroundColor: string

actualSeparatorHorizontalPaddingBottom

Section titled "actualSeparatorHorizontalPaddingBottom" 
actualSeparatorHorizontalPaddingBottom: number

actualSeparatorHorizontalPaddingLeft

Section titled "actualSeparatorHorizontalPaddingLeft" 
actualSeparatorHorizontalPaddingLeft: number

actualSeparatorHorizontalPaddingRight

Section titled "actualSeparatorHorizontalPaddingRight" 
actualSeparatorHorizontalPaddingRight: number

actualSeparatorHorizontalPaddingTop

Section titled "actualSeparatorHorizontalPaddingTop" 
actualSeparatorHorizontalPaddingTop: number

actualSeparatorVerticalPaddingBottom

Section titled "actualSeparatorVerticalPaddingBottom" 
actualSeparatorVerticalPaddingBottom: number

actualSeparatorVerticalPaddingLeft

Section titled "actualSeparatorVerticalPaddingLeft" 
actualSeparatorVerticalPaddingLeft: number

actualSeparatorVerticalPaddingRight

Section titled "actualSeparatorVerticalPaddingRight" 
actualSeparatorVerticalPaddingRight: number

actualSeparatorVerticalPaddingTop

Section titled "actualSeparatorVerticalPaddingTop" 
actualSeparatorVerticalPaddingTop: number

actualSubmenuBackgroundColor

Section titled "actualSubmenuBackgroundColor" 
actualSubmenuBackgroundColor: string

actualSubtitleTextColor

Section titled "actualSubtitleTextColor" 
actualSubtitleTextColor: string

actualTextColor

Section titled "actualTextColor" 
actualTextColor: string

actualToolTipBackgroundColor

Section titled "actualToolTipBackgroundColor" 
actualToolTipBackgroundColor: string

actualToolTipCornerRadius

Section titled "actualToolTipCornerRadius" 
actualToolTipCornerRadius: number

actualToolTipElevation

Section titled "actualToolTipElevation" 
actualToolTipElevation: number

actualToolTipTextColor

Section titled "actualToolTipTextColor" 
actualToolTipTextColor: string

actualUncheckedBackgroundColor

Section titled "actualUncheckedBackgroundColor" 
actualUncheckedBackgroundColor: string

actualUncheckedBorderColor

Section titled "actualUncheckedBorderColor" 
actualUncheckedBorderColor: string

backgroundColor

Section titled "backgroundColor" 
backgroundColor: string

baseTheme

Section titled "baseTheme" 
baseTheme: BaseControlTheme

cellTextStyle

Section titled "cellTextStyle" 
cellTextStyle: string

checkedBackgroundColor

Section titled "checkedBackgroundColor" 
checkedBackgroundColor: string

checkedBorderColor

Section titled "checkedBorderColor" 
checkedBorderColor: string

contentRefreshed

Section titled "contentRefreshed" 
contentRefreshed: object

density

Section titled "density" 
density: ControlDisplayDensity

disabledTextColor

Section titled "disabledTextColor" 
disabledTextColor: string
Section titled "dropdownClickBuffer" 
dropdownClickBuffer: number
Section titled "dropdownDelay" 
dropdownDelay: number

groupHeaderBackgroundColor

Section titled "groupHeaderBackgroundColor" 
groupHeaderBackgroundColor: string

groupHeaderSeparatorBackgroundColor

Section titled "groupHeaderSeparatorBackgroundColor" 
groupHeaderSeparatorBackgroundColor: string

groupHeaderSubtitleTextColor

Section titled "groupHeaderSubtitleTextColor" 
groupHeaderSubtitleTextColor: string

groupHeaderTextColor

Section titled "groupHeaderTextColor" 
groupHeaderTextColor: string

groupHeaderTextStyle

Section titled "groupHeaderTextStyle" 
groupHeaderTextStyle: string

height

Section titled "height" 
height: string

highlightColor

Section titled "highlightColor" 
highlightColor: string

highlightRadius

Section titled "highlightRadius" 
highlightRadius: number

highlightWidth

Section titled "highlightWidth" 
highlightWidth: number

hoverBackgroundColor

Section titled "hoverBackgroundColor" 
hoverBackgroundColor: string

iconFill

Section titled "iconFill" 
iconFill: string

iconStroke

Section titled "iconStroke" 
iconStroke: string

itemSpacing

Section titled "itemSpacing" 
itemSpacing: number
Section titled "menuArrowStroke" 
menuArrowStroke: string

nestedActionMode

Section titled "nestedActionMode" 
nestedActionMode: NestedActionMode

onCommand

Section titled "onCommand" 
onCommand: object

orientation

Section titled "orientation" 
orientation: ToolPanelOrientation

rowHeight

Section titled "rowHeight" 
rowHeight: number

scrollbarStyle

Section titled "scrollbarStyle" 
scrollbarStyle: ScrollbarStyle

separatorBackgroundColor

Section titled "separatorBackgroundColor" 
separatorBackgroundColor: string

separatorHorizontalPaddingBottom

Section titled "separatorHorizontalPaddingBottom" 
separatorHorizontalPaddingBottom: number

separatorHorizontalPaddingLeft

Section titled "separatorHorizontalPaddingLeft" 
separatorHorizontalPaddingLeft: number

separatorHorizontalPaddingRight

Section titled "separatorHorizontalPaddingRight" 
separatorHorizontalPaddingRight: number

separatorHorizontalPaddingTop

Section titled "separatorHorizontalPaddingTop" 
separatorHorizontalPaddingTop: number

separatorVerticalPaddingBottom

Section titled "separatorVerticalPaddingBottom" 
separatorVerticalPaddingBottom: number

separatorVerticalPaddingLeft

Section titled "separatorVerticalPaddingLeft" 
separatorVerticalPaddingLeft: number

separatorVerticalPaddingRight

Section titled "separatorVerticalPaddingRight" 
separatorVerticalPaddingRight: number

separatorVerticalPaddingTop

Section titled "separatorVerticalPaddingTop" 
separatorVerticalPaddingTop: number

showOnHover

Section titled "showOnHover" 
showOnHover: boolean

showTooltipOnHover

Section titled "showTooltipOnHover" 
showTooltipOnHover: boolean

stopPropagation

Section titled "stopPropagation" 
stopPropagation: boolean
Section titled "submenuBackgroundColor" 
submenuBackgroundColor: string

subtitleTextColor

Section titled "subtitleTextColor" 
subtitleTextColor: string

subtitleTextStyle

Section titled "subtitleTextStyle" 
subtitleTextStyle: string

textColor

Section titled "textColor" 
textColor: string

toolTipBackgroundColor

Section titled "toolTipBackgroundColor" 
toolTipBackgroundColor: string

toolTipCornerRadius

Section titled "toolTipCornerRadius" 
toolTipCornerRadius: number

toolTipElevation

Section titled "toolTipElevation" 
toolTipElevation: number

toolTipTextColor

Section titled "toolTipTextColor" 
toolTipTextColor: string

uncheckedBackgroundColor

Section titled "uncheckedBackgroundColor" 
uncheckedBackgroundColor: string

uncheckedBorderColor

Section titled "uncheckedBorderColor" 
uncheckedBorderColor: string

width

Section titled "width" 
width: string

Accessors

Section titled "Accessors"

actions

Section titled "actions"

A collection of manually added style mappings for the treemap.

get actions(): IgrToolActionCollection

Returns IgrToolActionCollection

actualRowHeight

Section titled "actualRowHeight"

Gets the actual row height used by the panel.

get actualRowHeight(): number

Returns number

i

Section titled "i" 
get i(): ToolPanel

Returns ToolPanel

isOpen

Section titled "isOpen" 
get isOpen(): boolean

Returns boolean

Methods

Section titled "Methods"

closeSubmenus

Section titled "closeSubmenus"

Forces any open sub menus to close.

closeSubmenus(): void

Returns void

componentDidMount

Section titled "componentDidMount" 
componentDidMount(): void

Returns void

componentWillUnmount

Section titled "componentWillUnmount" 
componentWillUnmount(): void

Returns void

destroy

Section titled "destroy" 
destroy(): void

Returns void

exportSerializedVisualData

Section titled "exportSerializedVisualData" 
exportSerializedVisualData(): string

Returns string

exportVisualData

Section titled "exportVisualData" 
exportVisualData(): any

Returns any

findByName

Section titled "findByName" 
findByName(name: string): any

Parameters

  • name: string

Returns any

flushRefresh

Section titled "flushRefresh" 
flushRefresh(): void

Returns void

getBoolContextItem

Section titled "getBoolContextItem" 
getBoolContextItem(key: string): boolean

Parameters

  • key: string

Returns boolean

getBrushCollectionContextItem

Section titled "getBrushCollectionContextItem" 
getBrushCollectionContextItem(key: string): string[]

Parameters

  • key: string

Returns string[]

getBrushContextItem

Section titled "getBrushContextItem" 
getBrushContextItem(key: string): string

Parameters

  • key: string

Returns string

getColorContextItem

Section titled "getColorContextItem" 
getColorContextItem(key: string): string

Parameters

  • key: string

Returns string

getDataContextItem

Section titled "getDataContextItem" 
getDataContextItem(key: string): any

Parameters

  • key: string

Returns any

getDesiredSize

Section titled "getDesiredSize" 
getDesiredSize(): IgSize

Returns IgSize

getDoubleContextItem

Section titled "getDoubleContextItem" 
getDoubleContextItem(key: string): number

Parameters

  • key: string

Returns number

getIntContextItem

Section titled "getIntContextItem" 
getIntContextItem(key: string): number

Parameters

  • key: string

Returns number

getStringContextItem

Section titled "getStringContextItem" 
getStringContextItem(key: string): string

Parameters

  • key: string

Returns string

initializeContent

Section titled "initializeContent" 
initializeContent(): void

Returns void

refresh

Section titled "refresh" 
refresh(): void

Returns void

render

Section titled "render" 
render(): DetailedReactHTMLElement<object, any>

Returns DetailedReactHTMLElement<object, any>

setBoolContextItem

Section titled "setBoolContextItem" 
setBoolContextItem(key: string, value: boolean): void

Parameters

  • key: string
  • value: boolean

Returns void

setBrushCollectionContextItem

Section titled "setBrushCollectionContextItem" 
setBrushCollectionContextItem(key: string, value: string[]): void

Parameters

  • key: string
  • value: string[]

Returns void

setBrushContextItem

Section titled "setBrushContextItem" 
setBrushContextItem(key: string, value: string): void

Parameters

  • key: string
  • value: string

Returns void

setColorContextItem

Section titled "setColorContextItem" 
setColorContextItem(key: string, value: string): void

Parameters

  • key: string
  • value: string

Returns void

setDataContextItem

Section titled "setDataContextItem" 
setDataContextItem(key: string, value: any): void

Parameters

  • key: string
  • value: any

Returns void

setDoubleContextItem

Section titled "setDoubleContextItem" 
setDoubleContextItem(key: string, value: number): void

Parameters

  • key: string
  • value: number

Returns void

setIntContextItem

Section titled "setIntContextItem" 
setIntContextItem(key: string, value: number): void

Parameters

  • key: string
  • value: number

Returns void

setStringContextItem

Section titled "setStringContextItem" 
setStringContextItem(key: string, value: string): void

Parameters

  • key: string
  • value: string

Returns void

shouldComponentUpdate

Section titled "shouldComponentUpdate" 
shouldComponentUpdate(nextProps: any, nextState: any): boolean

Parameters

  • nextProps: any
  • nextState: any

Returns boolean

updateStyle

Section titled "updateStyle" 
updateStyle(): void

Returns void