IgxToolActionComponent

Represents base class for all tool actions in toolbar

Constructors

new IgxToolActionComponent(): IgxToolActionComponent

Returns IgxToolActionComponent

Properties

contentActions

contentActions: QueryList<IgxToolActionComponent>

ngAcceptInputType_actions

ngAcceptInputType_actions: string | IgxToolActionCollection

ngAcceptInputType_actualDensity

ngAcceptInputType_actualDensity: any

ngAcceptInputType_actualHighlightRadius

ngAcceptInputType_actualHighlightRadius: string | number

ngAcceptInputType_actualHighlightWidth

ngAcceptInputType_actualHighlightWidth: string | number

ngAcceptInputType_actualIconHeight

ngAcceptInputType_actualIconHeight: string | number

ngAcceptInputType_actualIconWidth

ngAcceptInputType_actualIconWidth: string | number

ngAcceptInputType_actualPaddingBottom

ngAcceptInputType_actualPaddingBottom: string | number

ngAcceptInputType_actualPaddingLeft

ngAcceptInputType_actualPaddingLeft: string | number

ngAcceptInputType_actualPaddingRight

ngAcceptInputType_actualPaddingRight: string | number

ngAcceptInputType_actualPaddingTop

ngAcceptInputType_actualPaddingTop: string | number

ngAcceptInputType_actualSubPanelRowHeight

ngAcceptInputType_actualSubPanelRowHeight: string | number

ngAcceptInputType_closeOnExecute

ngAcceptInputType_closeOnExecute: string | boolean

ngAcceptInputType_contextBindings

ngAcceptInputType_contextBindings: string | IgxToolContextBindingCollection

ngAcceptInputType_density

ngAcceptInputType_density: any

ngAcceptInputType_height

ngAcceptInputType_height: string | number

ngAcceptInputType_highlightRadius

ngAcceptInputType_highlightRadius: string | number

ngAcceptInputType_highlightWidth

ngAcceptInputType_highlightWidth: string | number

ngAcceptInputType_iconFillColors

ngAcceptInputType_iconFillColors: string | string[]

ngAcceptInputType_iconHeight

ngAcceptInputType_iconHeight: string | number

ngAcceptInputType_iconStrokeColors

ngAcceptInputType_iconStrokeColors: string | string[]

ngAcceptInputType_iconStrokeWidth

ngAcceptInputType_iconStrokeWidth: string | number

ngAcceptInputType_iconViewBoxHeight

ngAcceptInputType_iconViewBoxHeight: string | number

ngAcceptInputType_iconViewBoxLeft

ngAcceptInputType_iconViewBoxLeft: string | number

ngAcceptInputType_iconViewBoxTop

ngAcceptInputType_iconViewBoxTop: string | number

ngAcceptInputType_iconViewBoxWidth

ngAcceptInputType_iconViewBoxWidth: string | number

ngAcceptInputType_iconWidth

ngAcceptInputType_iconWidth: string | number

ngAcceptInputType_isDisabled

ngAcceptInputType_isDisabled: string | boolean

ngAcceptInputType_isHighlighted

ngAcceptInputType_isHighlighted: string | boolean

ngAcceptInputType_isOpen

ngAcceptInputType_isOpen: string | boolean

ngAcceptInputType_paddingBottom

ngAcceptInputType_paddingBottom: string | number

ngAcceptInputType_paddingLeft

ngAcceptInputType_paddingLeft: string | number

ngAcceptInputType_paddingRight

ngAcceptInputType_paddingRight: string | number

ngAcceptInputType_paddingTop

ngAcceptInputType_paddingTop: string | number

ngAcceptInputType_subPanelRowHeight

ngAcceptInputType_subPanelRowHeight: string | number

ngAcceptInputType_titleHorizontalAlignment

ngAcceptInputType_titleHorizontalAlignment: any

ngAcceptInputType_visibility

ngAcceptInputType_visibility: any

ngAcceptInputType_width

ngAcceptInputType_width: string | number

ɵcmp

ɵcmp: ɵɵComponentDeclaration<IgxToolActionComponent, "ng-component", never, object, object, ["contentActions"], never, true, never>

ɵfac

ɵfac: ɵɵFactoryDeclaration<IgxToolActionComponent, never>

Accessors

accentColor

get accentColor(): string

Returns string

set accentColor(v: string): void

Parameters

v: string

Returns void

actionId

get actionId(): string

Returns string

actions

Gets the sub actions associated with this tool action.

get actions(): IgxToolActionCollection

Returns IgxToolActionCollection

actualAccentColor

get actualAccentColor(): string

Returns string

set actualAccentColor(v: string): void

Parameters

v: string

Returns void

actualActions

get actualActions(): IgxToolActionComponent[]

Returns IgxToolActionComponent[]

actualBackground

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

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

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

get actualHighlightColor(): string

Returns string

set actualHighlightColor(v: string): void

Parameters

v: string

Returns void

actualHighlightRadius

get actualHighlightRadius(): number

Returns number

set actualHighlightRadius(v: number): void

Parameters

v: number

Returns void

actualHighlightWidth

get actualHighlightWidth(): number

Returns number

set actualHighlightWidth(v: number): void

Parameters

v: number

Returns void

actualHoverBackground

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

Gets the actual icon fill color.

get actualIconFill(): string

Returns string

set actualIconFill(v: string): void

Parameters

v: string

Returns void

actualIconHeight

Gets the actual icon height used.

get actualIconHeight(): number

Returns number

set actualIconHeight(v: number): void

Parameters

v: number

Returns void

actualIconStroke

Gets the actual icon stroke color.

get actualIconStroke(): string

Returns string

set actualIconStroke(v: string): void

Parameters

v: string

Returns void

actualIconWidth

Gets the actual icon width used.

get actualIconWidth(): number

Returns number

set actualIconWidth(v: number): void

Parameters

v: number

Returns void

actualPaddingBottom

get actualPaddingBottom(): number

Returns number

set actualPaddingBottom(v: number): void

Parameters

v: number

Returns void

actualPaddingLeft

get actualPaddingLeft(): number

Returns number

set actualPaddingLeft(v: number): void

Parameters

v: number

Returns void

actualPaddingRight

get actualPaddingRight(): number

Returns number

set actualPaddingRight(v: number): void

Parameters

v: number

Returns void

actualPaddingTop

get actualPaddingTop(): number

Returns number

set actualPaddingTop(v: number): void

Parameters

v: number

Returns void

actualSubPanelRowHeight

get actualSubPanelRowHeight(): number

Returns number

set actualSubPanelRowHeight(v: number): void

Parameters

v: number

Returns void

actualSubtitleTextColor

Gets the actual label text color.

get actualSubtitleTextColor(): string

Returns string

set actualSubtitleTextColor(v: string): void

Parameters

v: string

Returns void

actualSubtitleTextStyle

Gets the actual font used.

get actualSubtitleTextStyle(): FontInfo

Returns FontInfo

set actualSubtitleTextStyle(v: FontInfo): void

Parameters

v: FontInfo

Returns void

actualTextColor

Gets the actual label text color.

get actualTextColor(): string

Returns string

set actualTextColor(v: string): void

Parameters

v: string

Returns void

actualTextStyle

Gets the actual font used.

get actualTextStyle(): FontInfo

Returns FontInfo

set actualTextStyle(v: FontInfo): void

Parameters

v: FontInfo

Returns void

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.

get afterId(): string

Returns string

set afterId(v: string): void

Parameters

v: string

Returns void

background

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

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

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

get commandArgument(): string

Returns string

set commandArgument(v: string): void

Parameters

v: string

Returns void

commandArgumentValue

get commandArgumentValue(): any

Returns any

set commandArgumentValue(v: any): void

Parameters

v: any

Returns void

commandId

get commandId(): string

Returns string

set commandId(v: string): void

Parameters

v: string

Returns void

contextBindings

Gets the context bindings for this tool action.

get contextBindings(): IgxToolContextBindingCollection

Returns IgxToolContextBindingCollection

set contextBindings(v: IgxToolContextBindingCollection): void

Parameters

v: IgxToolContextBindingCollection

Returns void

density

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

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

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

get highlightColor(): string

Returns string

set highlightColor(v: string): void

Parameters

v: string

Returns void

highlightRadius

get highlightRadius(): number

Returns number

set highlightRadius(v: number): void

Parameters

v: number

Returns void

highlightWidth

get highlightWidth(): number

Returns number

set highlightWidth(v: number): void

Parameters

v: number

Returns void

hoverBackground

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

get iconCollectionName(): string

Returns string

set iconCollectionName(v: string): void

Parameters

v: string

Returns void

iconFill

Gets or sets the icon fill color.

get iconFill(): string

Returns string

set iconFill(v: string): void

Parameters

v: string

Returns void

iconFillColors

Gets or sets the icon fill colors.

get iconFillColors(): string[]

Returns string[]

set iconFillColors(v: string[]): void

Parameters

v: string[]

Returns void

iconHeight

Gets or sets the height of the icon.

get iconHeight(): number

Returns number

set iconHeight(v: number): void

Parameters

v: number

Returns void

iconName

get iconName(): string

Returns string

set iconName(v: string): void

Parameters

v: string

Returns void

iconStroke

Gets or sets the icon stroke color.

get iconStroke(): string

Returns string

set iconStroke(v: string): void

Parameters

v: string

Returns void

iconStrokeColors

Gets or sets the icon stroke colors.

get iconStrokeColors(): string[]

Returns string[]

set iconStrokeColors(v: string[]): void

Parameters

v: string[]

Returns void

iconStrokeWidth

Gets or sets the icon viewbox width.

get iconStrokeWidth(): number

Returns number

set iconStrokeWidth(v: number): void

Parameters

v: number

Returns void

iconViewBoxHeight

Gets or sets the icon viewbox height.

get iconViewBoxHeight(): number

Returns number

set iconViewBoxHeight(v: number): void

Parameters

v: number

Returns void

iconViewBoxLeft

Gets or sets the icon viewbox left.

get iconViewBoxLeft(): number

Returns number

set iconViewBoxLeft(v: number): void

Parameters

v: number

Returns void

iconViewBoxTop

Gets or sets the icon viewbox top.

get iconViewBoxTop(): number

Returns number

set iconViewBoxTop(v: number): void

Parameters

v: number

Returns void

iconViewBoxWidth

Gets or sets the icon viewbox width.

get iconViewBoxWidth(): number

Returns number

set iconViewBoxWidth(v: number): void

Parameters

v: number

Returns void

iconWidth

Gets or sets the width of the icon.

get iconWidth(): number

Returns number

set iconWidth(v: number): void

Parameters

v: number

Returns void

isDisabled

get isDisabled(): boolean

Returns boolean

set isDisabled(v: boolean): void

Parameters

v: boolean

Returns void

isHighlighted

get isHighlighted(): boolean

Returns boolean

set isHighlighted(v: boolean): void

Parameters

v: boolean

Returns void

isOpen

get isOpen(): boolean

Returns boolean

name

get name(): string

Returns string

set name(v: string): void

Parameters

v: string

Returns void

onCommand

get onCommand(): EventEmitter<object>

Returns EventEmitter<object>

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.

get overlayId(): string

Returns string

set overlayId(v: string): void

Parameters

v: string

Returns void

paddingBottom

get paddingBottom(): number

Returns number

set paddingBottom(v: number): void

Parameters

v: number

Returns void

paddingLeft

get paddingLeft(): number

Returns number

set paddingLeft(v: number): void

Parameters

v: number

Returns void

paddingRight

get paddingRight(): number

Returns number

set paddingRight(v: number): void

Parameters

v: number

Returns void

paddingTop

get paddingTop(): number

Returns number

set paddingTop(v: number): void

Parameters

v: number

Returns void

parentId

get parentId(): string

Returns string

set parentId(v: string): void

Parameters

v: string

Returns void

performed

get performed(): EventEmitter<object>

Returns EventEmitter<object>

subPanelRowHeight

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

Gets or sets the subtitle of the tool.

get subtitle(): string

Returns string

set subtitle(v: string): void

Parameters

v: string

Returns void

subtitleTextColor

Gets or sets the label text color.

get subtitleTextColor(): string

Returns string

set subtitleTextColor(v: string): void

Parameters

v: string

Returns void

subtitleTextStyle

Gets or sets the font to use.

get subtitleTextStyle(): string

Returns string

set subtitleTextStyle(v: string): void

Parameters

v: string

Returns void

textColor

Gets or sets the label text color.

get textColor(): string

Returns string

set textColor(v: string): void

Parameters

v: string

Returns void

textStyle

Gets or sets the font to use.

get textStyle(): string

Returns string

set textStyle(v: string): void

Parameters

v: string

Returns void

title

Gets or sets the title of the tool.

get title(): string

Returns string

set title(v: string): void

Parameters

v: string

Returns void

titleHorizontalAlignment

Gets or sets the title horizontal alignment.

get titleHorizontalAlignment(): HorizontalAlignment

Returns HorizontalAlignment

set titleHorizontalAlignment(v: HorizontalAlignment): void

Parameters

v: HorizontalAlignment

Returns void

visibility

Gets or sets the tool action visibility.

get visibility(): Visibility

Returns Visibility

set visibility(v: Visibility): void

Parameters

v: Visibility

Returns void

width

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

closeSubmenu

closeSubmenu(): void

Returns void

exportSerializedVisualData

exportSerializedVisualData(): string

Returns string

exportVisualData

exportVisualData(): any

Returns any

findByName

findByName(name: string): any

Parameters

name: string

Returns any

ngAfterContentInit

ngAfterContentInit(): void

Returns void

ngOnInit

ngOnInit(): void

Returns void

openSubMenu

openSubMenu(): void

Returns void

_createFromInternal

_createFromInternal(internal: any): IgxToolActionComponent

Parameters

internal: any