Represents base class for all tool actions in toolbar

Constructors

Section titled "Constructors"

IgrToolActionNumberInput 

new IgrToolActionNumberInput(props: IIgrToolActionNumberInputProps): IgrToolActionNumberInput

Returns IgrToolActionNumberInput

Accessors

Section titled "Accessors"

accentColor

Section titled "accentColor"

Inherited from: IgrToolAction 

get accentColor(): string

Returns string 

set accentColor(v: string): void

Parameters

  • v: string

Returns void

actionId

Section titled "actionId"

Inherited from: IgrToolAction 

get actionId(): string

Returns string

actions

Section titled "actions"

Inherited from: IgrToolAction

Gets the sub actions associated with this tool action.

 
get actions(): IgrToolActionCollection

Returns IgrToolActionCollection

actualAccentColor

Section titled "actualAccentColor"

Inherited from: IgrToolAction 

get actualAccentColor(): string

Returns string 

set actualAccentColor(v: string): void

Parameters

  • v: string

Returns void

actualActions

Section titled "actualActions"

Inherited from: IgrToolAction

actualBackground

Section titled "actualBackground"

Inherited from: IgrToolAction

Gets the actual background used by the tool action.

 
get actualBackground(): string

Returns string 

set actualBackground(v: string): void

Parameters

  • v: string

Returns void

actualDensity

Section titled "actualDensity"

Inherited from: IgrToolAction

Gets the resolved display density to use for the action.

 
get actualDensity(): ControlDisplayDensity

Returns ControlDisplayDensity 

set actualDensity(v: ControlDisplayDensity): void

Parameters

  • v: ControlDisplayDensity

Returns void

actualDisabledTextColor

Section titled "actualDisabledTextColor"

Inherited from: IgrToolAction

Gets the actual label text color when the tool is disabled.

 
get actualDisabledTextColor(): string

Returns string 

set actualDisabledTextColor(v: string): void

Parameters

  • v: string

Returns void

actualHighlightColor

Section titled "actualHighlightColor"

Inherited from: IgrToolAction 

get actualHighlightColor(): string

Returns string 

set actualHighlightColor(v: string): void

Parameters

  • v: string

Returns void

actualHighlightRadius

Section titled "actualHighlightRadius"

Inherited from: IgrToolAction 

get actualHighlightRadius(): number

Returns number 

set actualHighlightRadius(v: number): void

Parameters

  • v: number

Returns void

actualHighlightWidth

Section titled "actualHighlightWidth"

Inherited from: IgrToolAction 

get actualHighlightWidth(): number

Returns number 

set actualHighlightWidth(v: number): void

Parameters

  • v: number

Returns void

actualHoverBackground

Section titled "actualHoverBackground"

Inherited from: IgrToolAction

Gets the actual hover background used by the tool action.

 
get actualHoverBackground(): string

Returns string 

set actualHoverBackground(v: string): void

Parameters

  • v: string

Returns void

actualIconFill

Section titled "actualIconFill"

Inherited from: IgrToolAction

Gets the actual icon fill color.

 
get actualIconFill(): string

Returns string 

set actualIconFill(v: string): void

Parameters

  • v: string

Returns void

actualIconHeight

Section titled "actualIconHeight"

Inherited from: IgrToolAction

Gets the actual icon height used.

 
get actualIconHeight(): number

Returns number 

set actualIconHeight(v: number): void

Parameters

  • v: number

Returns void

actualIconStroke

Section titled "actualIconStroke"

Inherited from: IgrToolAction

Gets the actual icon stroke color.

 
get actualIconStroke(): string

Returns string 

set actualIconStroke(v: string): void

Parameters

  • v: string

Returns void

actualIconWidth

Section titled "actualIconWidth"

Inherited from: IgrToolAction

Gets the actual icon width used.

 
get actualIconWidth(): number

Returns number 

set actualIconWidth(v: number): void

Parameters

  • v: number

Returns void

actualPaddingBottom

Section titled "actualPaddingBottom"

Inherited from: IgrToolAction 

get actualPaddingBottom(): number

Returns number 

set actualPaddingBottom(v: number): void

Parameters

  • v: number

Returns void

actualPaddingLeft

Section titled "actualPaddingLeft"

Inherited from: IgrToolAction 

get actualPaddingLeft(): number

Returns number 

set actualPaddingLeft(v: number): void

Parameters

  • v: number

Returns void

actualPaddingRight

Section titled "actualPaddingRight"

Inherited from: IgrToolAction 

get actualPaddingRight(): number

Returns number 

set actualPaddingRight(v: number): void

Parameters

  • v: number

Returns void

actualPaddingTop

Section titled "actualPaddingTop"

Inherited from: IgrToolAction 

get actualPaddingTop(): number

Returns number 

set actualPaddingTop(v: number): void

Parameters

  • v: number

Returns void

actualSubPanelRowHeight

Section titled "actualSubPanelRowHeight"

Inherited from: IgrToolAction 

get actualSubPanelRowHeight(): number

Returns number 

set actualSubPanelRowHeight(v: number): void

Parameters

  • v: number

Returns void

actualSubtitleTextColor

Section titled "actualSubtitleTextColor"

Inherited from: IgrToolAction

Gets the actual label text color.

 
get actualSubtitleTextColor(): string

Returns string 

set actualSubtitleTextColor(v: string): void

Parameters

  • v: string

Returns void

actualSubtitleTextStyle

Section titled "actualSubtitleTextStyle"

Inherited from: IgrToolAction

Gets the actual font used.

 
get actualSubtitleTextStyle(): FontInfo

Returns FontInfo 

set actualSubtitleTextStyle(v: FontInfo): void

Parameters

  • v: FontInfo

Returns void

actualTextColor

Section titled "actualTextColor"

Inherited from: IgrToolAction

Gets the actual label text color.

 
get actualTextColor(): string

Returns string 

set actualTextColor(v: string): void

Parameters

  • v: string

Returns void

actualTextStyle

Section titled "actualTextStyle"

Inherited from: IgrToolAction

Gets the actual font used.

 
get actualTextStyle(): FontInfo

Returns FontInfo 

set actualTextStyle(v: FontInfo): void

Parameters

  • v: FontInfo

Returns void

afterId

Section titled "afterId"

Inherited from: IgrToolAction

Gets or sets the Id of the action that this action will be inserted after. Subsequent actions will continue to insert after the target action, following the original action that set this property. If using this property do not use the BeforeId property. This property is only relevant during initial insertion into the toolbar. Changing the property after the action has already been added will have no effect.

 
get afterId(): string

Returns string 

set afterId(v: string): void

Parameters

  • v: string

Returns void

background

Section titled "background"

Inherited from: IgrToolAction

Gets or sets the background color of the tool action.

 
get background(): string

Returns string 

set background(v: string): void

Parameters

  • v: string

Returns void

beforeId

Section titled "beforeId"

Inherited from: IgrToolAction

Gets or sets the Id of the action that this action will be inserted before. Subsequent actions will continue to insert before the target action, following the original action that set this property. If using this property do not use the AfterId property. This property is only relevant during initial insertion into the toolbar. Changing the property after the action has already been added will have no effect.

 
get beforeId(): string

Returns string 

set beforeId(v: string): void

Parameters

  • v: string

Returns void

closeOnExecute

Section titled "closeOnExecute"

Inherited from: IgrToolAction

Gets or sets if the tool action will close its parent dropdown when executed by the user.

 
get closeOnExecute(): boolean

Returns boolean 

set closeOnExecute(v: boolean): void

Parameters

  • v: boolean

Returns void

commandArgument

Section titled "commandArgument"

Inherited from: IgrToolAction 

get commandArgument(): string

Returns string 

set commandArgument(v: string): void

Parameters

  • v: string

Returns void

commandArgumentValue

Section titled "commandArgumentValue"

Inherited from: IgrToolAction 

get commandArgumentValue(): any

Returns any 

set commandArgumentValue(v: any): void

Parameters

  • v: any

Returns void

commandId

Section titled "commandId"

Inherited from: IgrToolAction 

get commandId(): string

Returns string 

set commandId(v: string): void

Parameters

  • v: string

Returns void

contentActions

Section titled "contentActions"

Inherited from: IgrToolAction

contextBindings

Section titled "contextBindings"

Inherited from: IgrToolAction

Gets the context bindings for this tool action.

 
get contextBindings(): IgrToolContextBindingCollection

Returns IgrToolContextBindingCollection 

set contextBindings(v: IgrToolContextBindingCollection): void

Parameters

Returns void

density

Section titled "density"

Inherited from: IgrToolAction

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

 
get density(): ControlDisplayDensity

Returns ControlDisplayDensity 

set density(v: ControlDisplayDensity): void

Parameters

  • v: ControlDisplayDensity

Returns void

disabledTextColor

Section titled "disabledTextColor"

Inherited from: IgrToolAction

Gets or sets the label text color when the tool is disabled.

 
get disabledTextColor(): string

Returns string 

set disabledTextColor(v: string): void

Parameters

  • v: string

Returns void

height

Section titled "height"

Inherited from: IgrToolAction

Gets or sets the height to use for this tool action.

 
get height(): number

Returns number 

set height(v: number): void

Parameters

  • v: number

Returns void

highlightColor

Section titled "highlightColor"

Inherited from: IgrToolAction 

get highlightColor(): string

Returns string 

set highlightColor(v: string): void

Parameters

  • v: string

Returns void

highlightRadius

Section titled "highlightRadius"

Inherited from: IgrToolAction 

get highlightRadius(): number

Returns number 

set highlightRadius(v: number): void

Parameters

  • v: number

Returns void

highlightWidth

Section titled "highlightWidth"

Inherited from: IgrToolAction 

get highlightWidth(): number

Returns number 

set highlightWidth(v: number): void

Parameters

  • v: number

Returns void

hoverBackground

Section titled "hoverBackground"

Inherited from: IgrToolAction

Gets or sets the hover background for this tool action.

 
get hoverBackground(): string

Returns string 

set hoverBackground(v: string): void

Parameters

  • v: string

Returns void

iconCollectionName

Section titled "iconCollectionName"

Inherited from: IgrToolAction 

get iconCollectionName(): string

Returns string 

set iconCollectionName(v: string): void

Parameters

  • v: string

Returns void

iconFill

Section titled "iconFill"

Inherited from: IgrToolAction

Gets or sets the icon fill color.

 
get iconFill(): string

Returns string 

set iconFill(v: string): void

Parameters

  • v: string

Returns void

iconFillColors

Section titled "iconFillColors"

Inherited from: IgrToolAction

Gets or sets the icon fill colors.

 
get iconFillColors(): string[]

Returns string[] 

set iconFillColors(v: string[]): void

Parameters

  • v: string[]

Returns void

iconHeight

Section titled "iconHeight"

Inherited from: IgrToolAction

Gets or sets the height of the icon.

 
get iconHeight(): number

Returns number 

set iconHeight(v: number): void

Parameters

  • v: number

Returns void

iconName

Section titled "iconName"

Inherited from: IgrToolAction 

get iconName(): string

Returns string 

set iconName(v: string): void

Parameters

  • v: string

Returns void

iconStroke

Section titled "iconStroke"

Inherited from: IgrToolAction

Gets or sets the icon stroke color.

 
get iconStroke(): string

Returns string 

set iconStroke(v: string): void

Parameters

  • v: string

Returns void

iconStrokeColors

Section titled "iconStrokeColors"

Inherited from: IgrToolAction

Gets or sets the icon stroke colors.

 
get iconStrokeColors(): string[]

Returns string[] 

set iconStrokeColors(v: string[]): void

Parameters

  • v: string[]

Returns void

iconStrokeWidth

Section titled "iconStrokeWidth"

Inherited from: IgrToolAction

Gets or sets the icon viewbox width.

 
get iconStrokeWidth(): number

Returns number 

set iconStrokeWidth(v: number): void

Parameters

  • v: number

Returns void

iconViewBoxHeight

Section titled "iconViewBoxHeight"

Inherited from: IgrToolAction

Gets or sets the icon viewbox height.

 
get iconViewBoxHeight(): number

Returns number 

set iconViewBoxHeight(v: number): void

Parameters

  • v: number

Returns void

iconViewBoxLeft

Section titled "iconViewBoxLeft"

Inherited from: IgrToolAction

Gets or sets the icon viewbox left.

 
get iconViewBoxLeft(): number

Returns number 

set iconViewBoxLeft(v: number): void

Parameters

  • v: number

Returns void

iconViewBoxTop

Section titled "iconViewBoxTop"

Inherited from: IgrToolAction

Gets or sets the icon viewbox top.

 
get iconViewBoxTop(): number

Returns number 

set iconViewBoxTop(v: number): void

Parameters

  • v: number

Returns void

iconViewBoxWidth

Section titled "iconViewBoxWidth"

Inherited from: IgrToolAction

Gets or sets the icon viewbox width.

 
get iconViewBoxWidth(): number

Returns number 

set iconViewBoxWidth(v: number): void

Parameters

  • v: number

Returns void

iconWidth

Section titled "iconWidth"

Inherited from: IgrToolAction

Gets or sets the width of the icon.

 
get iconWidth(): number

Returns number 

set iconWidth(v: number): void

Parameters

  • v: number

Returns void

isDisabled

Section titled "isDisabled"

Inherited from: IgrToolAction 

get isDisabled(): boolean

Returns boolean 

set isDisabled(v: boolean): void

Parameters

  • v: boolean

Returns void

isHighlighted

Section titled "isHighlighted"

Inherited from: IgrToolAction 

get isHighlighted(): boolean

Returns boolean 

set isHighlighted(v: boolean): void

Parameters

  • v: boolean

Returns void

isOpen

Section titled "isOpen"

Inherited from: IgrToolAction 

get isOpen(): boolean

Returns boolean

name

Section titled "name"

Inherited from: IgrToolAction 

get name(): string

Returns string 

set name(v: string): void

Parameters

  • v: string

Returns void

nativeElement

Section titled "nativeElement"

Inherited from: IgrToolAction 

get nativeElement(): HTMLElement

Returns HTMLElement

onCommand

Section titled "onCommand"

Inherited from: IgrToolAction 

get onCommand(): object

Returns object 

set onCommand(ev: object): void

Parameters

  • ev: object

Returns void

overlayId

Section titled "overlayId"

Inherited from: IgrToolAction

Sets to the Id of the action that this action will overlay itself on to. The purpose of this property is to allow users to override actions automatically generated by toolbar targets such as the DataChart. These generated actions all have unique Ids associated with them that can be used for the OverlayId. These overlaid actions will not replace the generated one but will have its properties overlaid onto the generated actions.

 
get overlayId(): string

Returns string 

set overlayId(v: string): void

Parameters

  • v: string

Returns void

paddingBottom

Section titled "paddingBottom"

Inherited from: IgrToolAction 

get paddingBottom(): number

Returns number 

set paddingBottom(v: number): void

Parameters

  • v: number

Returns void

paddingLeft

Section titled "paddingLeft"

Inherited from: IgrToolAction 

get paddingLeft(): number

Returns number 

set paddingLeft(v: number): void

Parameters

  • v: number

Returns void

paddingRight

Section titled "paddingRight"

Inherited from: IgrToolAction 

get paddingRight(): number

Returns number 

set paddingRight(v: number): void

Parameters

  • v: number

Returns void

paddingTop

Section titled "paddingTop"

Inherited from: IgrToolAction 

get paddingTop(): number

Returns number 

set paddingTop(v: number): void

Parameters

  • v: number

Returns void

parentId

Section titled "parentId"

Inherited from: IgrToolAction 

get parentId(): string

Returns string 

set parentId(v: string): void

Parameters

  • v: string

Returns void

performed

Section titled "performed"

Inherited from: IgrToolAction 

get performed(): object

Returns object 

set performed(ev: object): void

Parameters

  • ev: object

Returns void

subPanelRowHeight

Section titled "subPanelRowHeight"

Inherited from: IgrToolAction

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

 
get subPanelRowHeight(): number

Returns number 

set subPanelRowHeight(v: number): void

Parameters

  • v: number

Returns void

subtitle

Section titled "subtitle"

Inherited from: IgrToolAction

Gets or sets the subtitle of the tool.

 
get subtitle(): string

Returns string 

set subtitle(v: string): void

Parameters

  • v: string

Returns void

subtitleTextColor

Section titled "subtitleTextColor"

Inherited from: IgrToolAction

Gets or sets the label text color.

 
get subtitleTextColor(): string

Returns string 

set subtitleTextColor(v: string): void

Parameters

  • v: string

Returns void

subtitleTextStyle

Section titled "subtitleTextStyle"

Inherited from: IgrToolAction

Gets or sets the font to use.

 
get subtitleTextStyle(): string

Returns string 

set subtitleTextStyle(v: string): void

Parameters

  • v: string

Returns void

textColor

Section titled "textColor"

Inherited from: IgrToolAction

Gets or sets the label text color.

 
get textColor(): string

Returns string 

set textColor(v: string): void

Parameters

  • v: string

Returns void

textStyle

Section titled "textStyle"

Inherited from: IgrToolAction

Gets or sets the font to use.

 
get textStyle(): string

Returns string 

set textStyle(v: string): void

Parameters

  • v: string

Returns void

title

Section titled "title"

Inherited from: IgrToolAction

Gets or sets the title of the tool.

 
get title(): string

Returns string 

set title(v: string): void

Parameters

  • v: string

Returns void

titleHorizontalAlignment

Section titled "titleHorizontalAlignment"

Inherited from: IgrToolAction

Gets or sets the title horizontal alignment.

 
get titleHorizontalAlignment(): HorizontalAlignment

Returns HorizontalAlignment 

set titleHorizontalAlignment(v: HorizontalAlignment): void

Parameters

  • v: HorizontalAlignment

Returns void

value

Section titled "value"

Gets or sets the value for the input.

 
get value(): number

Returns number 

set value(v: number): void

Parameters

  • v: number

Returns void

visibility

Section titled "visibility"

Inherited from: IgrToolAction

Gets or sets the tool action visibility.

 
get visibility(): Visibility

Returns Visibility 

set visibility(v: Visibility): void

Parameters

  • v: Visibility

Returns void

width

Section titled "width"

Inherited from: IgrToolAction

Gets or sets the width to use for this tool action.

 
get width(): number

Returns number 

set width(v: number): void

Parameters

  • v: number

Returns void

Methods

Section titled "Methods"

closeSubmenu

Section titled "closeSubmenu"

Inherited from: IgrToolAction 

closeSubmenu(): void

Returns void

componentDidMount

Section titled "componentDidMount"

Inherited from: IgrToolAction 

componentDidMount(): void

Returns void

exportSerializedVisualData

Section titled "exportSerializedVisualData"

Inherited from: IgrToolAction 

exportSerializedVisualData(): string

Returns string

exportVisualData

Section titled "exportVisualData" 
exportVisualData(): any

Returns any

findByName

Section titled "findByName"

Inherited from: IgrToolAction 

findByName(name: string): any

Parameters

  • name: string

Returns any

openSubMenu

Section titled "openSubMenu"

Inherited from: IgrToolAction 

openSubMenu(): void

Returns void

render

Section titled "render"

Inherited from: IgrToolAction 

render(): DetailedReactHTMLElement<object, HTMLElement>

Returns DetailedReactHTMLElement<object, HTMLElement>

shouldComponentUpdate

Section titled "shouldComponentUpdate"

Inherited from: IgrToolAction 

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

Parameters

  • nextProps: any
  • nextState: any

Returns boolean

_createFromInternal

Section titled "_createFromInternal"

Inherited from: IgrToolAction 

_createFromInternal(internal: any): IgrToolAction

Parameters

  • internal: any

Returns IgrToolAction