Constructors

Section titled "Constructors"

IgrToolbar

new IgrToolbar(props: IIgrToolbarProps): IgrToolbar

Returns IgrToolbar

Properties

Section titled "Properties"

combinedActions

Section titled "combinedActions"

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.

 
combinedActions: IgrToolAction<IIgrToolActionProps>[]

contentActions

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

accentColor

Section titled "accentColor" 
accentColor: string

actualActions

Section titled "actualActions" 
actualActions: IgrToolActionCollection

autoGeneratedActions

Section titled "autoGeneratedActions" 
autoGeneratedActions: IgrToolActionCollection

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

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

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
Section titled "menuArrowStroke" 
menuArrowStroke: string

onCommand

Section titled "onCommand" 
onCommand: object

orientation

Section titled "orientation" 
orientation: ToolbarOrientation

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
Section titled "subMenuClosing" 
subMenuClosing: object
Section titled "subMenuOpening" 
subMenuOpening: object

subtitleTextColor

Section titled "subtitleTextColor" 
subtitleTextColor: string

subtitleTextStyle

Section titled "subtitleTextStyle" 
subtitleTextStyle: string

target

Section titled "target" 
target: any

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

i

Section titled "i" 
get i(): Toolbar

Returns Toolbar

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

exportSerializedVisualData

Section titled "exportSerializedVisualData"

Returns a serialized copy of the exported visual model

exportSerializedVisualData(): string

Returns string

exportVisualData

Section titled "exportVisualData"

Exports visual information about the current state of the grid.

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

getDataURLFromCache

Section titled "getDataURLFromCache" 
getDataURLFromCache(iconCollection: string, iconName: string): string

Parameters

  • iconCollection: string
  • iconName: string

Returns string

getDesiredSize

Section titled "getDesiredSize"

Get the desired size the toolbar wants to be.

getDesiredSize(): IgSize

Returns IgSize

getDoubleContextItem

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

Parameters

  • key: string

Returns number

getExternalDataContextItem

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

Parameters

  • key: string

Returns any

getExternalDoubleContextItem

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

Parameters

  • key: string

Returns number

getExternalIntContextItem

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

Parameters

  • key: string

Returns number

getIconFromCache

Section titled "getIconFromCache" 
getIconFromCache(iconCollection: string, iconName: string): string

Parameters

  • iconCollection: string
  • iconName: string

Returns string

getIconSource

Section titled "getIconSource" 
getIconSource(iconCollection: string, iconName: string): any

Parameters

  • iconCollection: string
  • iconName: string

Returns any

getIntContextItem

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

Parameters

  • key: string

Returns number

getMultiPathSVGFromCache

Section titled "getMultiPathSVGFromCache" 
getMultiPathSVGFromCache(iconCollection: string, iconName: string): string[]

Parameters

  • iconCollection: string
  • iconName: string

Returns string[]

getStringContextItem

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

Parameters

  • key: string

Returns string

initializeContent

Section titled "initializeContent" 
initializeContent(): void

Returns void

isOpen

Section titled "isOpen"

Is a dropdown menu or tooltip currently open.

isOpen(): boolean

Returns boolean

onCommandStateChanged

Section titled "onCommandStateChanged" 
onCommandStateChanged(id: string, type: any, value: any): void

Parameters

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

Returns void

registerIconFromDataURL

Section titled "registerIconFromDataURL" 
registerIconFromDataURL(iconCollection: string, iconName: string, dataURL: string): void

Parameters

  • iconCollection: string
  • iconName: string
  • dataURL: string

Returns void

registerIconFromText

Section titled "registerIconFromText" 
registerIconFromText(iconCollection: string, iconName: string, iconText: string): void

Parameters

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

Returns void

registerIconSource

Section titled "registerIconSource" 
registerIconSource(iconCollection: string, iconName: string, source: any): void

Parameters

  • iconCollection: string
  • iconName: string
  • source: any

Returns void

registerMultiPathSVG

Section titled "registerMultiPathSVG" 
registerMultiPathSVG(iconCollection: string, iconName: string, multiPathSVG: string[]): void

Parameters

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

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

setExternalDataContextItem

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

Parameters

  • key: string
  • value: any

Returns void

setExternalDoubleContextItem

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

Parameters

  • key: string
  • value: any

Returns void

setExternalIntContextItem

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

Parameters

  • key: string
  • value: any

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