Represents base class for all tool actions in toolbar

Constructors

Section titled "Constructors"

IgrToolAction

new IgrToolAction(props: P): IgrToolAction

Returns IgrToolAction

Properties

Section titled "Properties"

accentColor

Section titled "accentColor" 
accentColor: string

actualAccentColor

Section titled "actualAccentColor" 
actualAccentColor: string

actualBackground

Section titled "actualBackground" 
actualBackground: string

actualDensity

Section titled "actualDensity" 
actualDensity: ControlDisplayDensity

actualDisabledTextColor

Section titled "actualDisabledTextColor" 
actualDisabledTextColor: string

actualHighlightColor

Section titled "actualHighlightColor" 
actualHighlightColor: string

actualHighlightRadius

Section titled "actualHighlightRadius" 
actualHighlightRadius: number

actualHighlightWidth

Section titled "actualHighlightWidth" 
actualHighlightWidth: number

actualHoverBackground

Section titled "actualHoverBackground" 
actualHoverBackground: string

actualIconFill

Section titled "actualIconFill" 
actualIconFill: string

actualIconHeight

Section titled "actualIconHeight" 
actualIconHeight: number

actualIconStroke

Section titled "actualIconStroke" 
actualIconStroke: string

actualIconWidth

Section titled "actualIconWidth" 
actualIconWidth: number

actualPaddingBottom

Section titled "actualPaddingBottom" 
actualPaddingBottom: number

actualPaddingLeft

Section titled "actualPaddingLeft" 
actualPaddingLeft: number

actualPaddingRight

Section titled "actualPaddingRight" 
actualPaddingRight: number

actualPaddingTop

Section titled "actualPaddingTop" 
actualPaddingTop: number

actualSubtitleTextColor

Section titled "actualSubtitleTextColor" 
actualSubtitleTextColor: string

actualSubtitleTextStyle

Section titled "actualSubtitleTextStyle" 
actualSubtitleTextStyle: FontInfo

actualTextColor

Section titled "actualTextColor" 
actualTextColor: string

actualTextStyle

Section titled "actualTextStyle" 
actualTextStyle: FontInfo

afterId

Section titled "afterId" 
afterId: string

background

Section titled "background" 
background: string

beforeId

Section titled "beforeId" 
beforeId: string

closeOnExecute

Section titled "closeOnExecute" 
closeOnExecute: boolean

commandArgument

Section titled "commandArgument" 
commandArgument: string

commandArgumentValue

Section titled "commandArgumentValue" 
commandArgumentValue: any

commandId

Section titled "commandId" 
commandId: string

contextBindings

Section titled "contextBindings" 
contextBindings: IgrToolContextBindingCollection

density

Section titled "density" 
density: ControlDisplayDensity

disabledTextColor

Section titled "disabledTextColor" 
disabledTextColor: string

height

Section titled "height" 
height: number

highlightColor

Section titled "highlightColor" 
highlightColor: string

highlightRadius

Section titled "highlightRadius" 
highlightRadius: number

highlightWidth

Section titled "highlightWidth" 
highlightWidth: number

hoverBackground

Section titled "hoverBackground" 
hoverBackground: string

iconCollectionName

Section titled "iconCollectionName" 
iconCollectionName: string

iconFill

Section titled "iconFill" 
iconFill: string

iconFillColors

Section titled "iconFillColors" 
iconFillColors: string[]

iconHeight

Section titled "iconHeight" 
iconHeight: number

iconName

Section titled "iconName" 
iconName: string

iconStroke

Section titled "iconStroke" 
iconStroke: string

iconStrokeColors

Section titled "iconStrokeColors" 
iconStrokeColors: string[]

iconStrokeWidth

Section titled "iconStrokeWidth" 
iconStrokeWidth: number

iconViewBoxHeight

Section titled "iconViewBoxHeight" 
iconViewBoxHeight: number

iconViewBoxLeft

Section titled "iconViewBoxLeft" 
iconViewBoxLeft: number

iconViewBoxTop

Section titled "iconViewBoxTop" 
iconViewBoxTop: number

iconViewBoxWidth

Section titled "iconViewBoxWidth" 
iconViewBoxWidth: number

iconWidth

Section titled "iconWidth" 
iconWidth: number

isDisabled

Section titled "isDisabled" 
isDisabled: boolean

isHighlighted

Section titled "isHighlighted" 
isHighlighted: boolean

name

Section titled "name" 
name: string

onCommand

Section titled "onCommand" 
onCommand: object

overlayId

Section titled "overlayId" 
overlayId: string

paddingBottom

Section titled "paddingBottom" 
paddingBottom: number

paddingLeft

Section titled "paddingLeft" 
paddingLeft: number

paddingRight

Section titled "paddingRight" 
paddingRight: number

paddingTop

Section titled "paddingTop" 
paddingTop: number

parentId

Section titled "parentId" 
parentId: string

performed

Section titled "performed" 
performed: object

subPanelRowHeight

Section titled "subPanelRowHeight" 
subPanelRowHeight: number

subtitle

Section titled "subtitle" 
subtitle: string

subtitleTextColor

Section titled "subtitleTextColor" 
subtitleTextColor: string

subtitleTextStyle

Section titled "subtitleTextStyle" 
subtitleTextStyle: string

textColor

Section titled "textColor" 
textColor: string

textStyle

Section titled "textStyle" 
textStyle: string

title

Section titled "title" 
title: string

titleHorizontalAlignment

Section titled "titleHorizontalAlignment" 
titleHorizontalAlignment: HorizontalAlignment

visibility

Section titled "visibility" 
visibility: Visibility

width

Section titled "width" 
width: number

Accessors

Section titled "Accessors"

actionId

Section titled "actionId" 
get actionId(): string

Returns string

actions

Section titled "actions"

Gets the sub actions associated with this tool action.

get actions(): IgrToolActionCollection

Returns IgrToolActionCollection

actualActions

Section titled "actualActions"

contentActions

Section titled "contentActions"

isOpen

Section titled "isOpen" 
get isOpen(): boolean

Returns boolean

nativeElement

Section titled "nativeElement" 
get nativeElement(): HTMLElement

Returns HTMLElement

Methods

Section titled "Methods"

closeSubmenu

Section titled "closeSubmenu" 
closeSubmenu(): void

Returns void

componentDidMount

Section titled "componentDidMount" 
componentDidMount(): 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

openSubMenu

Section titled "openSubMenu" 
openSubMenu(): void

Returns void

render

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

Returns DetailedReactHTMLElement<object, HTMLElement>

shouldComponentUpdate

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

Parameters

  • nextProps: any
  • nextState: any

Returns boolean

_createFromInternal

Section titled "_createFromInternal" 
_createFromInternal(internal: any): IgrToolAction

Parameters

  • internal: any

Returns IgrToolAction