IIgrToolActionSubPanelProps

Optional accentColor

Section titled "accentColor"

Inherited from: IIgrToolActionProps

accentColor?: string

Optional actualAccentColor

Section titled "actualAccentColor"

Inherited from: IIgrToolActionProps

actualAccentColor?: string

Optional actualBackground

Section titled "actualBackground"

Inherited from: IIgrToolActionProps

Gets the actual background used by the tool action.

actualBackground?: string

Optional actualDensity

Section titled "actualDensity"

Inherited from: IIgrToolActionProps

Gets the resolved display density to use for the action.

actualDensity?: any

Optional actualDisabledTextColor

Section titled "actualDisabledTextColor"

Inherited from: IIgrToolActionProps

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

actualDisabledTextColor?: string

Optional actualHighlightColor

Section titled "actualHighlightColor"

Inherited from: IIgrToolActionProps

actualHighlightColor?: string

Optional actualHighlightRadius

Section titled "actualHighlightRadius"

Inherited from: IIgrToolActionProps

actualHighlightRadius?: string | number

Optional actualHighlightWidth

Section titled "actualHighlightWidth"

Inherited from: IIgrToolActionProps

actualHighlightWidth?: string | number

Optional actualHoverBackground

Section titled "actualHoverBackground"

Inherited from: IIgrToolActionProps

Gets the actual hover background used by the tool action.

actualHoverBackground?: string

Optional actualIconFill

Section titled "actualIconFill"

Inherited from: IIgrToolActionProps

Gets the actual icon fill color.

actualIconFill?: string

Optional actualIconHeight

Section titled "actualIconHeight"

Inherited from: IIgrToolActionProps

Gets the actual icon height used.

actualIconHeight?: string | number

Optional actualIconStroke

Section titled "actualIconStroke"

Inherited from: IIgrToolActionProps

Gets the actual icon stroke color.

actualIconStroke?: string

Optional actualIconWidth

Section titled "actualIconWidth"

Inherited from: IIgrToolActionProps

Gets the actual icon width used.

actualIconWidth?: string | number

Optional actualPaddingBottom

Section titled "actualPaddingBottom"

Inherited from: IIgrToolActionProps

actualPaddingBottom?: string | number

Optional actualPaddingLeft

Section titled "actualPaddingLeft"

Inherited from: IIgrToolActionProps

actualPaddingLeft?: string | number

Optional actualPaddingRight

Section titled "actualPaddingRight"

Inherited from: IIgrToolActionProps

actualPaddingRight?: string | number

Optional actualPaddingTop

Section titled "actualPaddingTop"

Inherited from: IIgrToolActionProps

actualPaddingTop?: string | number

Optional actualSubtitleTextColor

Section titled "actualSubtitleTextColor"

Inherited from: IIgrToolActionProps

Gets the actual label text color.

actualSubtitleTextColor?: string

Optional actualSubtitleTextStyle

Section titled "actualSubtitleTextStyle"

Inherited from: IIgrToolActionProps

Gets the actual font used.

actualSubtitleTextStyle?: FontInfo

Optional actualTextColor

Section titled "actualTextColor"

Inherited from: IIgrToolActionProps

Gets the actual label text color.

actualTextColor?: string

Optional actualTextStyle

Section titled "actualTextStyle"

Inherited from: IIgrToolActionProps

Gets the actual font used.

actualTextStyle?: FontInfo

Inherited from: IIgrToolActionProps

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.

afterId?: string

Optional background

Section titled "background"

Inherited from: IIgrToolActionProps

Gets or sets the background color of the tool action.

background?: string

Optional beforeId

Section titled "beforeId"

Inherited from: IIgrToolActionProps

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.

beforeId?: string

Optional children

Section titled "children"

Inherited from: IIgrToolActionProps

children?: ReactNode

Optional closeOnExecute

Section titled "closeOnExecute"

Inherited from: IIgrToolActionProps

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

closeOnExecute?: string | boolean

Optional commandArgument

Section titled "commandArgument"

Inherited from: IIgrToolActionProps

commandArgument?: string

Optional commandArgumentValue

Section titled "commandArgumentValue"

Inherited from: IIgrToolActionProps

commandArgumentValue?: any

Optional commandId

Section titled "commandId"

Inherited from: IIgrToolActionProps

commandId?: string

Optional contextBindings

Section titled "contextBindings"

Inherited from: IIgrToolActionProps

Gets the context bindings for this tool action.

contextBindings?: string | IgrToolContextBindingCollection

Inherited from: IIgrToolActionProps

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

density?: any

Optional disabledTextColor

Section titled "disabledTextColor"

Inherited from: IIgrToolActionProps

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

disabledTextColor?: string

Inherited from: IIgrToolActionProps

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

height?: string | number

Optional highlightColor

Section titled "highlightColor"

Inherited from: IIgrToolActionProps

highlightColor?: string

Optional highlightRadius

Section titled "highlightRadius"

Inherited from: IIgrToolActionProps

highlightRadius?: string | number

Optional highlightWidth

Section titled "highlightWidth"

Inherited from: IIgrToolActionProps

highlightWidth?: string | number

Optional hoverBackground

Section titled "hoverBackground"

Inherited from: IIgrToolActionProps

Gets or sets the hover background for this tool action.

hoverBackground?: string

Optional iconCollectionName

Section titled "iconCollectionName"

Inherited from: IIgrToolActionProps

iconCollectionName?: string

Optional iconFill

Section titled "iconFill"

Inherited from: IIgrToolActionProps

Gets or sets the icon fill color.

iconFill?: string

Optional iconFillColors

Section titled "iconFillColors"

Inherited from: IIgrToolActionProps

Gets or sets the icon fill colors.

iconFillColors?: string | string[]

Optional iconHeight

Section titled "iconHeight"

Inherited from: IIgrToolActionProps

Gets or sets the height of the icon.

iconHeight?: string | number

Optional iconName

Section titled "iconName"

Inherited from: IIgrToolActionProps

iconName?: string

Optional iconStroke

Section titled "iconStroke"

Inherited from: IIgrToolActionProps

Gets or sets the icon stroke color.

iconStroke?: string

Optional iconStrokeColors

Section titled "iconStrokeColors"

Inherited from: IIgrToolActionProps

Gets or sets the icon stroke colors.

iconStrokeColors?: string | string[]

Optional iconStrokeWidth

Section titled "iconStrokeWidth"

Inherited from: IIgrToolActionProps

Gets or sets the icon viewbox width.

iconStrokeWidth?: string | number

Optional iconViewBoxHeight

Section titled "iconViewBoxHeight"

Inherited from: IIgrToolActionProps

Gets or sets the icon viewbox height.

iconViewBoxHeight?: string | number

Optional iconViewBoxLeft

Section titled "iconViewBoxLeft"

Inherited from: IIgrToolActionProps

Gets or sets the icon viewbox left.

iconViewBoxLeft?: string | number

Optional iconViewBoxTop

Section titled "iconViewBoxTop"

Inherited from: IIgrToolActionProps

Gets or sets the icon viewbox top.

iconViewBoxTop?: string | number

Optional iconViewBoxWidth

Section titled "iconViewBoxWidth"

Inherited from: IIgrToolActionProps

Gets or sets the icon viewbox width.

iconViewBoxWidth?: string | number

Optional iconWidth

Section titled "iconWidth"

Inherited from: IIgrToolActionProps

Gets or sets the width of the icon.

iconWidth?: string | number

Optional isDisabled

Section titled "isDisabled"

Inherited from: IIgrToolActionProps

isDisabled?: string | boolean

Optional isHighlighted

Section titled "isHighlighted"

Inherited from: IIgrToolActionProps

isHighlighted?: string | boolean

Optional itemSpacing

Section titled "itemSpacing"

Gets or sets the spacing between items.

itemSpacing?: string | number

Inherited from: IIgrToolActionProps

name?: string

Optional onCommand

Section titled "onCommand"

Inherited from: IIgrToolActionProps

onCommand?: object

Optional overlayId

Section titled "overlayId"

Inherited from: IIgrToolActionProps

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.

overlayId?: string

Optional paddingBottom

Section titled "paddingBottom"

Inherited from: IIgrToolActionProps

paddingBottom?: string | number

Optional paddingLeft

Section titled "paddingLeft"

Inherited from: IIgrToolActionProps

paddingLeft?: string | number

Optional paddingRight

Section titled "paddingRight"

Inherited from: IIgrToolActionProps

paddingRight?: string | number

Optional paddingTop

Section titled "paddingTop"

Inherited from: IIgrToolActionProps

paddingTop?: string | number

Optional parentId

Section titled "parentId"

Inherited from: IIgrToolActionProps

parentId?: string

Optional performed

Section titled "performed"

Inherited from: IIgrToolActionProps

performed?: object

Optional subPanelRowHeight

Section titled "subPanelRowHeight"

Inherited from: IIgrToolActionProps

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

subPanelRowHeight?: string | number

Optional subtitle

Section titled "subtitle"

Inherited from: IIgrToolActionProps

Gets or sets the subtitle of the tool.

subtitle?: string

Optional subtitleTextColor

Section titled "subtitleTextColor"

Inherited from: IIgrToolActionProps

Gets or sets the label text color.

subtitleTextColor?: string

Optional subtitleTextStyle

Section titled "subtitleTextStyle"

Inherited from: IIgrToolActionProps

Gets or sets the font to use.

subtitleTextStyle?: string

Optional textColor

Section titled "textColor"

Inherited from: IIgrToolActionProps

Gets or sets the label text color.

textColor?: string

Optional textStyle

Section titled "textStyle"

Inherited from: IIgrToolActionProps

Gets or sets the font to use.

textStyle?: string

Inherited from: IIgrToolActionProps

Gets or sets the title of the tool.

title?: string

Optional titleHorizontalAlignment

Section titled "titleHorizontalAlignment"

Inherited from: IIgrToolActionProps

Gets or sets the title horizontal alignment.

titleHorizontalAlignment?: any

Optional visibility

Section titled "visibility"

Inherited from: IIgrToolActionProps

Gets or sets the tool action visibility.

visibility?: any

Inherited from: IIgrToolActionProps

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

width?: string | number