IIgrToolActionProps

Properties

Optional accentColor

accentColor?: string

Optional actualAccentColor

actualAccentColor?: string

Optional actualBackground

Gets the actual background used by the tool action.

actualBackground?: string

Optional actualDensity

Gets the resolved display density to use for the action.

actualDensity?: any

Optional actualDisabledTextColor

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

actualDisabledTextColor?: string

Optional actualHighlightColor

actualHighlightColor?: string

Optional actualHighlightRadius

actualHighlightRadius?: string | number

Optional actualHighlightWidth

actualHighlightWidth?: string | number

Optional actualHoverBackground

Gets the actual hover background used by the tool action.

actualHoverBackground?: string

Optional actualIconFill

Gets the actual icon fill color.

actualIconFill?: string

Optional actualIconHeight

Gets the actual icon height used.

actualIconHeight?: string | number

Optional actualIconStroke

Gets the actual icon stroke color.

actualIconStroke?: string

Optional actualIconWidth

Gets the actual icon width used.

actualIconWidth?: string | number

Optional actualPaddingBottom

actualPaddingBottom?: string | number

Optional actualPaddingLeft

actualPaddingLeft?: string | number

Optional actualPaddingRight

actualPaddingRight?: string | number

Optional actualPaddingTop

actualPaddingTop?: string | number

Optional actualSubtitleTextColor

Gets the actual label text color.

actualSubtitleTextColor?: string

Optional actualSubtitleTextStyle

Gets the actual font used.

actualSubtitleTextStyle?: FontInfo

Optional actualTextColor

Gets the actual label text color.

actualTextColor?: string

Optional actualTextStyle

Gets the actual font used.

actualTextStyle?: FontInfo

Optional afterId

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

Gets or sets the background color of the tool action.

background?: string

Optional beforeId

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

children?: ReactNode

Optional closeOnExecute

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

closeOnExecute?: string | boolean

Optional commandArgument

commandArgument?: string

Optional commandArgumentValue

commandArgumentValue?: any

Optional commandId

commandId?: string

Optional contextBindings

Gets the context bindings for this tool action.

contextBindings?: string | IgrToolContextBindingCollection

Optional density

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

density?: any

Optional disabledTextColor

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

disabledTextColor?: string

Optional height

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

height?: string | number

Optional highlightColor

highlightColor?: string

Optional highlightRadius

highlightRadius?: string | number

Optional highlightWidth

highlightWidth?: string | number

Optional hoverBackground

Gets or sets the hover background for this tool action.

hoverBackground?: string

Optional iconCollectionName

iconCollectionName?: string

Optional iconFill

Gets or sets the icon fill color.

iconFill?: string

Optional iconFillColors

Gets or sets the icon fill colors.

iconFillColors?: string | string[]

Optional iconHeight

Gets or sets the height of the icon.

iconHeight?: string | number

Optional iconName

iconName?: string

Optional iconStroke

Gets or sets the icon stroke color.

iconStroke?: string

Optional iconStrokeColors

Gets or sets the icon stroke colors.

iconStrokeColors?: string | string[]

Optional iconStrokeWidth

Gets or sets the icon viewbox width.

iconStrokeWidth?: string | number

Optional iconViewBoxHeight

Gets or sets the icon viewbox height.

iconViewBoxHeight?: string | number

Optional iconViewBoxLeft

Gets or sets the icon viewbox left.

iconViewBoxLeft?: string | number

Optional iconViewBoxTop

Gets or sets the icon viewbox top.

iconViewBoxTop?: string | number

Optional iconViewBoxWidth

Gets or sets the icon viewbox width.

iconViewBoxWidth?: string | number

Optional iconWidth

Gets or sets the width of the icon.

iconWidth?: string | number

Optional isDisabled

isDisabled?: string | boolean

Optional isHighlighted

isHighlighted?: string | boolean

Optional name

name?: string

Optional onCommand

onCommand?: object

Optional overlayId

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

paddingBottom?: string | number

Optional paddingLeft

paddingLeft?: string | number

Optional paddingRight

paddingRight?: string | number

Optional paddingTop

paddingTop?: string | number

Optional parentId

parentId?: string

Optional performed

performed?: object

Optional subPanelRowHeight

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

subPanelRowHeight?: string | number

Optional subtitle

Gets or sets the subtitle of the tool.

subtitle?: string

Optional subtitleTextColor

Gets or sets the label text color.

subtitleTextColor?: string

Optional subtitleTextStyle

Gets or sets the font to use.

subtitleTextStyle?: string

Optional textColor

Gets or sets the label text color.

textColor?: string

Optional textStyle

Gets or sets the font to use.

textStyle?: string

Optional title

Gets or sets the title of the tool.

title?: string

Optional titleHorizontalAlignment

Gets or sets the title horizontal alignment.

titleHorizontalAlignment?: any

Optional visibility

Gets or sets the tool action visibility.

visibility?: any

Optional width

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

width?: string | number