Ignite UI for Angular

All
  • Public
  • Public/Protected
  • All

Class IgxToolActionRadioComponent

Represents base class for all tool actions in toolbar

Hierarchy

Hierarchy

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Static ngAcceptInputType_actions

ngAcceptInputType_actions: string | IgxToolActionCollection

Static ngAcceptInputType_actualPaddingBottom

ngAcceptInputType_actualPaddingBottom: string | number

Static ngAcceptInputType_actualPaddingLeft

ngAcceptInputType_actualPaddingLeft: string | number

Static ngAcceptInputType_actualPaddingRight

ngAcceptInputType_actualPaddingRight: string | number

Static ngAcceptInputType_actualPaddingTop

ngAcceptInputType_actualPaddingTop: string | number

Static ngAcceptInputType_iconViewBoxHeight

ngAcceptInputType_iconViewBoxHeight: string | number

Static ngAcceptInputType_iconViewBoxLeft

ngAcceptInputType_iconViewBoxLeft: string | number

Static ngAcceptInputType_iconViewBoxTop

ngAcceptInputType_iconViewBoxTop: string | number

Static ngAcceptInputType_iconViewBoxWidth

ngAcceptInputType_iconViewBoxWidth: string | number

Static ngAcceptInputType_isChecked

ngAcceptInputType_isChecked: string | boolean

Static ngAcceptInputType_isDisabled

ngAcceptInputType_isDisabled: string | boolean

Static ngAcceptInputType_paddingBottom

ngAcceptInputType_paddingBottom: string | number

Static ngAcceptInputType_paddingLeft

ngAcceptInputType_paddingLeft: string | number

Static ngAcceptInputType_paddingRight

ngAcceptInputType_paddingRight: string | number

Static ngAcceptInputType_paddingTop

ngAcceptInputType_paddingTop: string | number

Static ngAcceptInputType_visibility

ngAcceptInputType_visibility: string | Visibility

Static ngAcceptInputType_width

ngAcceptInputType_width: string | number

Static ɵcmp

ɵcmp: unknown

Static ɵfac

ɵfac: unknown

Accessors

actions

  • get actions(): IgxToolActionCollection

  • Gets the sub actions associated with this tool action.

    Returns IgxToolActionCollection

  • set actions(v: IgxToolActionCollection): void

  • Parameters

    Returns void

actualBackground

  • get actualBackground(): string

  • Gets the actual background used by the tool action.

    Returns string

  • set actualBackground(v: string): void

  • Parameters

    • v: string

    Returns void

actualDisabledTextColor

  • get actualDisabledTextColor(): string

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

    Returns string

  • set actualDisabledTextColor(v: string): void

  • Parameters

    • v: string

    Returns void

actualHoverBackground

  • get actualHoverBackground(): string

  • Gets the actual hover background used by the tool action.

    Returns string

  • set actualHoverBackground(v: string): void

  • Parameters

    • v: string

    Returns void

actualIconFill

  • get actualIconFill(): string

  • Gets the actual icon fill color.

    Returns string

  • set actualIconFill(v: string): void

  • Parameters

    • v: string

    Returns void

actualIconStroke

  • get actualIconStroke(): string

  • Gets the actual icon stroke color.

    Returns string

  • set actualIconStroke(v: string): void

  • Parameters

    • v: string

    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

actualTextColor

  • get actualTextColor(): string

  • Gets the actual label text color.

    Returns string

  • set actualTextColor(v: string): void

  • Parameters

    • v: string

    Returns void

actualTextStyle

  • get actualTextStyle(): string

  • Gets the actual font used.

    Returns string

  • set actualTextStyle(v: string): void

  • Parameters

    • v: string

    Returns void

afterId

  • get afterId(): string

  • 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.

    Returns string

  • set afterId(v: string): void

  • Parameters

    • v: string

    Returns void

background

  • get background(): string

  • Gets or sets the background color of the tool action.

    Returns string

  • set background(v: string): void

  • Parameters

    • v: string

    Returns void

beforeId

  • get beforeId(): string

  • 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.

    Returns string

  • set beforeId(v: string): void

  • Parameters

    • v: string

    Returns void

channel

  • get channel(): string

  • Gets or sets the channel this radio button belongs to.

    Returns string

  • set channel(v: string): void

  • Parameters

    • v: string

    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

disabledTextColor

  • get disabledTextColor(): string

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

    Returns string

  • set disabledTextColor(v: string): void

  • Parameters

    • v: string

    Returns void

hoverBackground

  • get hoverBackground(): string

  • Gets or sets the hover background for this tool action.

    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

  • get iconFill(): string

  • Gets or sets the icon fill color.

    Returns string

  • set iconFill(v: string): void

  • Parameters

    • v: string

    Returns void

iconName

  • get iconName(): string

  • Returns string

  • set iconName(v: string): void

  • Parameters

    • v: string

    Returns void

iconStroke

  • get iconStroke(): string

  • Gets or sets the icon stroke color.

    Returns string

  • set iconStroke(v: string): void

  • Parameters

    • v: string

    Returns void

iconViewBoxHeight

  • get iconViewBoxHeight(): number

  • Gets or sets the icon viewbox height.

    Returns number

  • set iconViewBoxHeight(v: number): void

  • Parameters

    • v: number

    Returns void

iconViewBoxLeft

  • get iconViewBoxLeft(): number

  • Gets or sets the icon viewbox left.

    Returns number

  • set iconViewBoxLeft(v: number): void

  • Parameters

    • v: number

    Returns void

iconViewBoxTop

  • get iconViewBoxTop(): number

  • Gets or sets the icon viewbox top.

    Returns number

  • set iconViewBoxTop(v: number): void

  • Parameters

    • v: number

    Returns void

iconViewBoxWidth

  • get iconViewBoxWidth(): number

  • Gets or sets the icon viewbox width.

    Returns number

  • set iconViewBoxWidth(v: number): void

  • Parameters

    • v: number

    Returns void

id

  • get id(): string

  • Returns string

isChecked

  • get isChecked(): boolean

  • Gets or sets if the tool action is checked.

    Returns boolean

  • set isChecked(v: boolean): void

  • Parameters

    • v: boolean

    Returns void

isDisabled

  • get isDisabled(): boolean

  • Returns boolean

  • set isDisabled(v: boolean): void

  • Parameters

    • v: boolean

    Returns void

name

  • get name(): string

  • Returns string

  • set name(v: string): void

  • Parameters

    • v: string

    Returns void

onCommand

  • get onCommand(): EventEmitter<{
        args: IgxToolCommandEventArgs;
        sender: any;
    }>

  • Returns EventEmitter<{
        args: IgxToolCommandEventArgs;
        sender: any;
    }>

overlayId

  • get overlayId(): string

  • 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.

    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<{
        args: IgxToolActionPerformedEventArgs;
        sender: any;
    }>

  • Returns EventEmitter<{
        args: IgxToolActionPerformedEventArgs;
        sender: any;
    }>

subtitle

  • get subtitle(): string

  • Gets or sets the subtitle of the tool.

    Returns string

  • set subtitle(v: string): void

  • Parameters

    • v: string

    Returns void

textColor

  • get textColor(): string

  • Gets or sets the label text color.

    Returns string

  • set textColor(v: string): void

  • Parameters

    • v: string

    Returns void

textStyle

  • get textStyle(): string

  • Gets or sets the font to use.

    Returns string

  • set textStyle(v: string): void

  • Parameters

    • v: string

    Returns void

title

  • get title(): string

  • Gets or sets the title of the tool.

    Returns string

  • set title(v: string): void

  • Parameters

    • v: string

    Returns void

visibility

  • get visibility(): Visibility

  • Gets or sets the tool action visibility.

    Returns Visibility

  • set visibility(v: Visibility): void

  • Parameters

    Returns void

width

  • get width(): number

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

    Returns number

  • set width(v: number): void

  • Parameters

    • v: number

    Returns void

Methods

cleanUp

  • Returns void

closeSubmenu

findByName

  • Parameters

    • name: string

    Returns any

fromInfo

  • Parameters

    • info: ToolActionInfo

    Returns void

ngOnInit

  • Returns void

openSubMenu

Static _createFromInternal