Hierarchy

Hierarchy

  • IgxXButtonComponent

Implements

  • AfterViewInit

Constructors

Properties

Accessors

Methods

Constructors

  • Parameters

    • renderer: Renderer2
    • _elRef: ViewContainerRef
    • ngZone: NgZone
    • injector: Injector
    • componentFactoryResolver: ComponentFactoryResolver

    Returns IgxXButtonComponent

Properties

_childTemplateRef: TemplateRef<any>
_dynamicContent: ViewContainerRef
container: Element
ngAcceptInputType_actualBorderWidth: string | number
ngAcceptInputType_actualCornerRadiusBottomLeft: string | number
ngAcceptInputType_actualCornerRadiusBottomRight: string | number
ngAcceptInputType_actualCornerRadiusTopLeft: string | number
ngAcceptInputType_actualCornerRadiusTopRight: string | number
ngAcceptInputType_actualDensity: string | ControlDisplayDensity
ngAcceptInputType_actualDisableRipple: string | boolean
ngAcceptInputType_actualDisabledElevation: string | number
ngAcceptInputType_actualElevationMode: string | ElevationMode
ngAcceptInputType_actualFocusElevation: string | number
ngAcceptInputType_actualHoverElevation: string | number
ngAcceptInputType_actualRestingElevation: string | number
ngAcceptInputType_baseTheme: string | BaseControlTheme
ngAcceptInputType_borderWidth: string | number
ngAcceptInputType_clickTunneling: string | boolean
ngAcceptInputType_contentPaddingBottom: string | number
ngAcceptInputType_contentPaddingLeft: string | number
ngAcceptInputType_contentPaddingRight: string | number
ngAcceptInputType_contentPaddingTop: string | number
ngAcceptInputType_cornerRadiusBottomLeft: string | number
ngAcceptInputType_cornerRadiusBottomRight: string | number
ngAcceptInputType_cornerRadiusTopLeft: string | number
ngAcceptInputType_cornerRadiusTopRight: string | number
ngAcceptInputType_density: string | ControlDisplayDensity
ngAcceptInputType_disableHover: string | boolean
ngAcceptInputType_disablePointer: string | boolean
ngAcceptInputType_disableRipple: string | boolean
ngAcceptInputType_disableTransitions: string | boolean
ngAcceptInputType_disabled: string | boolean
ngAcceptInputType_disabledElevation: string | number
ngAcceptInputType_displayType: string | ButtonDisplayStyle
ngAcceptInputType_elevationMode: string | ElevationMode
ngAcceptInputType_fabBorderWidth: string | number
ngAcceptInputType_fabCornerRadiusBottomLeft: string | number
ngAcceptInputType_fabCornerRadiusBottomRight: string | number
ngAcceptInputType_fabCornerRadiusTopLeft: string | number
ngAcceptInputType_fabCornerRadiusTopRight: string | number
ngAcceptInputType_fabDisabledElevation: string | number
ngAcceptInputType_fabFocusElevation: string | number
ngAcceptInputType_fabHoverElevation: string | number
ngAcceptInputType_fabRestingElevation: string | number
ngAcceptInputType_fillAvailableSpace: string | boolean
ngAcceptInputType_flatBorderWidth: string | number
ngAcceptInputType_flatCornerRadiusBottomLeft: string | number
ngAcceptInputType_flatCornerRadiusBottomRight: string | number
ngAcceptInputType_flatCornerRadiusTopLeft: string | number
ngAcceptInputType_flatCornerRadiusTopRight: string | number
ngAcceptInputType_flatDisabledElevation: string | number
ngAcceptInputType_flatFocusElevation: string | number
ngAcceptInputType_flatHoverElevation: string | number
ngAcceptInputType_flatRestingElevation: string | number
ngAcceptInputType_focusElevation: string | number
ngAcceptInputType_focused: string | boolean
ngAcceptInputType_horizontalContentAlignment: string | HorizontalAlignment
ngAcceptInputType_hoverElevation: string | number
ngAcceptInputType_iconBorderWidth: string | number
ngAcceptInputType_iconCornerRadiusBottomLeft: string | number
ngAcceptInputType_iconCornerRadiusBottomRight: string | number
ngAcceptInputType_iconCornerRadiusTopLeft: string | number
ngAcceptInputType_iconCornerRadiusTopRight: string | number
ngAcceptInputType_iconDisabledElevation: string | number
ngAcceptInputType_iconFocusElevation: string | number
ngAcceptInputType_iconHoverElevation: string | number
ngAcceptInputType_iconRestingElevation: string | number
ngAcceptInputType_isFocusStyleEnabled: string | boolean
ngAcceptInputType_isHover: string | boolean
ngAcceptInputType_minHeight: string | number
ngAcceptInputType_minWidth: string | number
ngAcceptInputType_outlinedBorderWidth: string | number
ngAcceptInputType_outlinedCornerRadiusBottomLeft: string | number
ngAcceptInputType_outlinedCornerRadiusBottomRight: string | number
ngAcceptInputType_outlinedCornerRadiusTopLeft: string | number
ngAcceptInputType_outlinedCornerRadiusTopRight: string | number
ngAcceptInputType_outlinedDisabledElevation: string | number
ngAcceptInputType_outlinedFocusElevation: string | number
ngAcceptInputType_outlinedHoverElevation: string | number
ngAcceptInputType_outlinedRestingElevation: string | number
ngAcceptInputType_raisedBorderWidth: string | number
ngAcceptInputType_raisedCornerRadiusBottomLeft: string | number
ngAcceptInputType_raisedCornerRadiusBottomRight: string | number
ngAcceptInputType_raisedCornerRadiusTopLeft: string | number
ngAcceptInputType_raisedCornerRadiusTopRight: string | number
ngAcceptInputType_raisedDisabledElevation: string | number
ngAcceptInputType_raisedFocusElevation: string | number
ngAcceptInputType_raisedHoverElevation: string | number
ngAcceptInputType_raisedRestingElevation: string | number
ngAcceptInputType_restingElevation: string | number
ngAcceptInputType_tabIndex: string | number
ngAcceptInputType_verticalContentAlignment: string | VerticalAlignment
ɵcmp: unknown
ɵfac: unknown

Accessors

  • get actualAmbientShadowColor(): string
  • Gets or sets the color to use for the check mark when the checkbox is checked.

    Returns string

  • set actualAmbientShadowColor(v: string): void
  • Parameters

    • v: string

    Returns void

  • get actualBackgroundColor(): string
  • Gets the color to use for the actual background.

    Returns string

  • set actualBackgroundColor(v: string): void
  • Parameters

    • v: string

    Returns void

  • get actualBorderColor(): string
  • Gets or sets the color to use for the check mark when the checkbox is checked.

    Returns string

  • set actualBorderColor(v: string): void
  • Parameters

    • v: string

    Returns void

  • get actualBorderWidth(): number
  • Gets or sets the Width to use for the check mark when the checkbox is checked.

    Returns number

  • set actualBorderWidth(v: number): void
  • Parameters

    • v: number

    Returns void

  • get actualCornerRadiusBottomLeft(): number
  • Returns number

  • set actualCornerRadiusBottomLeft(v: number): void
  • Parameters

    • v: number

    Returns void

  • get actualCornerRadiusBottomRight(): number
  • Returns number

  • set actualCornerRadiusBottomRight(v: number): void
  • Parameters

    • v: number

    Returns void

  • get actualCornerRadiusTopLeft(): number
  • Returns number

  • set actualCornerRadiusTopLeft(v: number): void
  • Parameters

    • v: number

    Returns void

  • get actualCornerRadiusTopRight(): number
  • Returns number

  • set actualCornerRadiusTopRight(v: number): void
  • Parameters

    • v: number

    Returns void

  • get actualDisableRipple(): boolean
  • Gets whether to actually disable the ripple effect for the button.

    Returns boolean

  • set actualDisableRipple(v: boolean): void
  • Parameters

    • v: boolean

    Returns void

  • get actualDisabledBackgroundColor(): string
  • Gets the actual color to use for the disabled background of the button.

    Returns string

  • set actualDisabledBackgroundColor(v: string): void
  • Parameters

    • v: string

    Returns void

  • get actualDisabledBorderColor(): string
  • Gets the actual color to use for the disabled border of the button.

    Returns string

  • set actualDisabledBorderColor(v: string): void
  • Parameters

    • v: string

    Returns void

  • get actualDisabledElevation(): number
  • Gets the actual disabled elevation to use for the button.

    Returns number

  • set actualDisabledElevation(v: number): void
  • Parameters

    • v: number

    Returns void

  • get actualDisabledTextColor(): string
  • Gets the actual color to use for the disabled text of the button.

    Returns string

  • set actualDisabledTextColor(v: string): void
  • Parameters

    • v: string

    Returns void

  • get actualElevationMode(): ElevationMode
  • Gets the actual disabled elevation to use for the button.

    Returns ElevationMode

  • set actualElevationMode(v: ElevationMode): void
  • Parameters

    Returns void

  • get actualFocusBackgroundColor(): string
  • Gets the color to use for the actual background.

    Returns string

  • set actualFocusBackgroundColor(v: string): void
  • Parameters

    • v: string

    Returns void

  • get actualFocusElevation(): number
  • Gets or sets the color to use for the check mark when the checkbox is checked.

    Returns number

  • set actualFocusElevation(v: number): void
  • Parameters

    • v: number

    Returns void

  • get actualFocusTextColor(): string
  • Gets the actual color to use for the focused text.

    Returns string

  • set actualFocusTextColor(v: string): void
  • Parameters

    • v: string

    Returns void

  • get actualHoverBackgroundColor(): string
  • Gets the hover color to use for the actual background.

    Returns string

  • set actualHoverBackgroundColor(v: string): void
  • Parameters

    • v: string

    Returns void

  • get actualHoverElevation(): number
  • Gets or sets the color to use for the check mark when the checkbox is checked.

    Returns number

  • set actualHoverElevation(v: number): void
  • Parameters

    • v: number

    Returns void

  • get actualHoverTextColor(): string
  • Gets the color to use for the actual background.

    Returns string

  • set actualHoverTextColor(v: string): void
  • Parameters

    • v: string

    Returns void

  • get actualPenumbraShadowColor(): string
  • Gets or sets the color to use for the check mark when the checkbox is checked.

    Returns string

  • set actualPenumbraShadowColor(v: string): void
  • Parameters

    • v: string

    Returns void

  • get actualRestingElevation(): number
  • Gets or sets the color to use for the check mark when the checkbox is checked.

    Returns number

  • set actualRestingElevation(v: number): void
  • Parameters

    • v: number

    Returns void

  • get actualRippleColor(): string
  • Gets or sets the color to use for the ripple when the button is pressed.

    Returns string

  • set actualRippleColor(v: string): void
  • Parameters

    • v: string

    Returns void

  • get actualTextColor(): string
  • Gets the color to use for the actual background.

    Returns string

  • set actualTextColor(v: string): void
  • Parameters

    • v: string

    Returns void

  • get actualUmbraShadowColor(): string
  • Gets or sets the color to use for the check mark when the checkbox is checked.

    Returns string

  • set actualUmbraShadowColor(v: string): void
  • Parameters

    • v: string

    Returns void

  • get alignItems(): string
  • Gets or sets the id to use for the checkbox.

    Returns string

  • set alignItems(v: string): void
  • Parameters

    • v: string

    Returns void

  • get ariaLabel(): string
  • Gets or sets the value of the aria-label attribute.

    Returns string

  • set ariaLabel(v: string): void
  • Parameters

    • v: string

    Returns void

  • get backgroundColor(): string
  • Gets or sets the color to use for the background when the button regardless of type.

    Returns string

  • set backgroundColor(v: string): void
  • Parameters

    • v: string

    Returns void

  • get baseTheme(): BaseControlTheme
  • Gets or sets the base built in theme to use for the button.

    Returns BaseControlTheme

  • set baseTheme(v: BaseControlTheme): void
  • Parameters

    Returns void

  • get borderColor(): string
  • Gets or sets the border color to use for the button regardless of type.

    Returns string

  • set borderColor(v: string): void
  • Parameters

    • v: string

    Returns void

  • get borderWidth(): number
  • Gets or sets the width to use for the button border regardless of type.

    Returns number

  • set borderWidth(v: number): void
  • Parameters

    • v: number

    Returns void

  • get clickTunneling(): boolean
  • Gets or sets if clicking on the button is allowed to tunnel down to button content.

    Returns boolean

  • set clickTunneling(v: boolean): void
  • Parameters

    • v: boolean

    Returns void

  • get clicked(): EventEmitter<{
        args: IgxButtonClickEventArgs;
        sender: any;
    }>
  • Returns EventEmitter<{
        args: IgxButtonClickEventArgs;
        sender: any;
    }>

  • get contentPaddingBottom(): number
  • Gets or sets the bottom padding for the button content.

    Returns number

  • set contentPaddingBottom(v: number): void
  • Parameters

    • v: number

    Returns void

  • get contentPaddingLeft(): number
  • Gets or sets the left padding for the button content.

    Returns number

  • set contentPaddingLeft(v: number): void
  • Parameters

    • v: number

    Returns void

  • get contentPaddingRight(): number
  • Gets or sets the right padding for the button content.

    Returns number

  • set contentPaddingRight(v: number): void
  • Parameters

    • v: number

    Returns void

  • get contentPaddingTop(): number
  • Gets or sets the top padding for the button content.

    Returns number

  • set contentPaddingTop(v: number): void
  • Parameters

    • v: number

    Returns void

  • get cornerRadiusBottomLeft(): number
  • Returns number

  • set cornerRadiusBottomLeft(v: number): void
  • Parameters

    • v: number

    Returns void

  • get cornerRadiusBottomRight(): number
  • Returns number

  • set cornerRadiusBottomRight(v: number): void
  • Parameters

    • v: number

    Returns void

  • get cornerRadiusTopLeft(): number
  • Returns number

  • set cornerRadiusTopLeft(v: number): void
  • Parameters

    • v: number

    Returns void

  • get cornerRadiusTopRight(): number
  • Returns number

  • set cornerRadiusTopRight(v: number): void
  • Parameters

    • v: number

    Returns void

  • get disableHover(): boolean
  • Gets or sets whether the hover effect is disabled.

    Returns boolean

  • set disableHover(v: boolean): void
  • Parameters

    • v: boolean

    Returns void

  • get disablePointer(): boolean
  • Gets or sets whether the cursor will change into a pointer when the button is hovered.

    Returns boolean

  • set disablePointer(v: boolean): void
  • Parameters

    • v: boolean

    Returns void

  • get disableRipple(): boolean
  • Gets or sets whether to disable the ripple effect for the button.

    Returns boolean

  • set disableRipple(v: boolean): void
  • Parameters

    • v: boolean

    Returns void

  • get disableTransitions(): boolean
  • Gets or sets whether the checkbox transitions are disabled.

    Returns boolean

  • set disableTransitions(v: boolean): void
  • Parameters

    • v: boolean

    Returns void

  • get disabled(): boolean
  • Gets or sets whether the checkbox is disabled.

    Returns boolean

  • set disabled(v: boolean): void
  • Parameters

    • v: boolean

    Returns void

  • get disabledBackgroundColor(): string
  • Gets or sets the color to use for the disabled background of the button when the type is disabled.

    Returns string

  • set disabledBackgroundColor(v: string): void
  • Parameters

    • v: string

    Returns void

  • get disabledBorderColor(): string
  • Gets or sets the color to use for the disabled border of the button when the type is raised.

    Returns string

  • set disabledBorderColor(v: string): void
  • Parameters

    • v: string

    Returns void

  • get disabledElevation(): number
  • Gets or sets the disabled elevation to use for the button when the type is raised.

    Returns number

  • set disabledElevation(v: number): void
  • Parameters

    • v: number

    Returns void

  • get disabledTextColor(): string
  • Gets or sets the color to use for the disabled text of the button when the type is raised.

    Returns string

  • set disabledTextColor(v: string): void
  • Parameters

    • v: string

    Returns void

  • get display(): string
  • Gets or sets the id to use for the checkbox.

    Returns string

  • set display(v: string): void
  • Parameters

    • v: string

    Returns void

  • get displayType(): ButtonDisplayStyle
  • Gets or sets the display style to use for the button.

    Returns ButtonDisplayStyle

  • set displayType(v: ButtonDisplayStyle): void
  • Parameters

    • v: ButtonDisplayStyle

    Returns void

  • get elevationMode(): ElevationMode
  • Gets or sets the disabled elevation to use for the button when the type is raised.

    Returns ElevationMode

  • set elevationMode(v: ElevationMode): void
  • Parameters

    Returns void

  • get fabBackgroundColor(): string
  • Gets or sets the color to use for the background of the button when the type is floating action button.

    Returns string

  • set fabBackgroundColor(v: string): void
  • Parameters

    • v: string

    Returns void

  • get fabBorderColor(): string
  • Gets or sets the border color to use for the button when the type is floating action button.

    Returns string

  • set fabBorderColor(v: string): void
  • Parameters

    • v: string

    Returns void

  • get fabBorderWidth(): number
  • Gets or sets the width to use for the button border when the type is floating action button.

    Returns number

  • set fabBorderWidth(v: number): void
  • Parameters

    • v: number

    Returns void

  • get fabCornerRadiusBottomLeft(): number
  • Returns number

  • set fabCornerRadiusBottomLeft(v: number): void
  • Parameters

    • v: number

    Returns void

  • get fabCornerRadiusBottomRight(): number
  • Returns number

  • set fabCornerRadiusBottomRight(v: number): void
  • Parameters

    • v: number

    Returns void

  • get fabCornerRadiusTopLeft(): number
  • Returns number

  • set fabCornerRadiusTopLeft(v: number): void
  • Parameters

    • v: number

    Returns void

  • get fabCornerRadiusTopRight(): number
  • Returns number

  • set fabCornerRadiusTopRight(v: number): void
  • Parameters

    • v: number

    Returns void

  • get fabDisabledBackgroundColor(): string
  • Gets or sets the color to use for the disabled background of the button when the type is fab.

    Returns string

  • set fabDisabledBackgroundColor(v: string): void
  • Parameters

    • v: string

    Returns void

  • get fabDisabledBorderColor(): string
  • Gets or sets the color to use for the disabled border of the button when the type is fab.

    Returns string

  • set fabDisabledBorderColor(v: string): void
  • Parameters

    • v: string

    Returns void

  • get fabDisabledElevation(): number
  • Gets or sets the disabled elevation to use for the button when the type is fab.

    Returns number

  • set fabDisabledElevation(v: number): void
  • Parameters

    • v: number

    Returns void

  • get fabDisabledTextColor(): string
  • Gets or sets the color to use for the disabled text of the button when the type is fab.

    Returns string

  • set fabDisabledTextColor(v: string): void
  • Parameters

    • v: string

    Returns void

  • get fabFocusBackgroundColor(): string
  • Gets or sets the color to use for the backround the button when it is focused and fab.

    Returns string

  • set fabFocusBackgroundColor(v: string): void
  • Parameters

    • v: string

    Returns void

  • get fabFocusElevation(): number
  • Gets or sets the focus elevation to use for the button when the type is floating action button.

    Returns number

  • set fabFocusElevation(v: number): void
  • Parameters

    • v: number

    Returns void

  • get fabFocusTextColor(): string
  • Gets or sets the color to use for the text the button when it is focused and fab.

    Returns string

  • set fabFocusTextColor(v: string): void
  • Parameters

    • v: string

    Returns void

  • get fabHoverBackgroundColor(): string
  • Gets or sets the hover color to use for the background of the button when the type is hoveredFab.

    Returns string

  • set fabHoverBackgroundColor(v: string): void
  • Parameters

    • v: string

    Returns void

  • get fabHoverElevation(): number
  • Gets or sets the hover elevation to use for the button when the type is floating action button.

    Returns number

  • set fabHoverElevation(v: number): void
  • Parameters

    • v: number

    Returns void

  • get fabHoverTextColor(): string
  • Gets or sets the color to use for the hovered text of the button when type is floating action button.

    Returns string

  • set fabHoverTextColor(v: string): void
  • Parameters

    • v: string

    Returns void

  • get fabRestingElevation(): number
  • Gets or sets the elevation to use for the button when the type is floating action button.

    Returns number

  • set fabRestingElevation(v: number): void
  • Parameters

    • v: number

    Returns void

  • get fabRippleColor(): string
  • Gets or sets the color to use for the background when the button is pressed and the type is floating action button.

    Returns string

  • set fabRippleColor(v: string): void
  • Parameters

    • v: string

    Returns void

  • get fabTextColor(): string
  • Gets or sets the color to use for the text of the button when type is floating action button.

    Returns string

  • set fabTextColor(v: string): void
  • Parameters

    • v: string

    Returns void

  • get fillAvailableSpace(): boolean
  • Gets or sets whether the button should fill the available space. If false, the button will use an intrinsic size.

    Returns boolean

  • set fillAvailableSpace(v: boolean): void
  • Parameters

    • v: boolean

    Returns void

  • get flatBackgroundColor(): string
  • Gets or sets the color to use for the background of the button when the type is flat.

    Returns string

  • set flatBackgroundColor(v: string): void
  • Parameters

    • v: string

    Returns void

  • get flatBorderColor(): string
  • Gets or sets the border color to use for the button when the type is flat.

    Returns string

  • set flatBorderColor(v: string): void
  • Parameters

    • v: string

    Returns void

  • get flatBorderWidth(): number
  • Gets or sets the width to use for the button border when the type is flat.

    Returns number

  • set flatBorderWidth(v: number): void
  • Parameters

    • v: number

    Returns void

  • get flatCornerRadiusBottomLeft(): number
  • Returns number

  • set flatCornerRadiusBottomLeft(v: number): void
  • Parameters

    • v: number

    Returns void

  • get flatCornerRadiusBottomRight(): number
  • Returns number

  • set flatCornerRadiusBottomRight(v: number): void
  • Parameters

    • v: number

    Returns void

  • get flatCornerRadiusTopLeft(): number
  • Returns number

  • set flatCornerRadiusTopLeft(v: number): void
  • Parameters

    • v: number

    Returns void

  • get flatCornerRadiusTopRight(): number
  • Returns number

  • set flatCornerRadiusTopRight(v: number): void
  • Parameters

    • v: number

    Returns void

  • get flatDisabledBackgroundColor(): string
  • Gets or sets the color to use for the disabled background of the button when the type is flat.

    Returns string

  • set flatDisabledBackgroundColor(v: string): void
  • Parameters

    • v: string

    Returns void

  • get flatDisabledBorderColor(): string
  • Gets or sets the color to use for the disabled border of the button when the type is flat.

    Returns string

  • set flatDisabledBorderColor(v: string): void
  • Parameters

    • v: string

    Returns void

  • get flatDisabledElevation(): number
  • Gets or sets the disabled elevation to use for the button when the type is flat.

    Returns number

  • set flatDisabledElevation(v: number): void
  • Parameters

    • v: number

    Returns void

  • get flatDisabledTextColor(): string
  • Gets or sets the color to use for the disabled text of the button when the type is flat.

    Returns string

  • set flatDisabledTextColor(v: string): void
  • Parameters

    • v: string

    Returns void

  • get flatFocusBackgroundColor(): string
  • Gets or sets the color to use for the backround the button when it is focused and flat.

    Returns string

  • set flatFocusBackgroundColor(v: string): void
  • Parameters

    • v: string

    Returns void

  • get flatFocusElevation(): number
  • Gets or sets the focus elevation to use for the button when the type is flat.

    Returns number

  • set flatFocusElevation(v: number): void
  • Parameters

    • v: number

    Returns void

  • get flatFocusTextColor(): string
  • Gets or sets the color to use for the text the button when it is focused and flat.

    Returns string

  • set flatFocusTextColor(v: string): void
  • Parameters

    • v: string

    Returns void

  • get flatHoverBackgroundColor(): string
  • Gets or sets the hover color to use for the background of the button when the type is flat.

    Returns string

  • set flatHoverBackgroundColor(v: string): void
  • Parameters

    • v: string

    Returns void

  • get flatHoverElevation(): number
  • Gets or sets the hover elevation to use for the button when the type is flat.

    Returns number

  • set flatHoverElevation(v: number): void
  • Parameters

    • v: number

    Returns void

  • get flatHoverTextColor(): string
  • Gets or sets the color to use for the hovered text of the button when type is flat.

    Returns string

  • set flatHoverTextColor(v: string): void
  • Parameters

    • v: string

    Returns void

  • get flatRestingElevation(): number
  • Gets or sets the elevation to use for the button when the type is flat.

    Returns number

  • set flatRestingElevation(v: number): void
  • Parameters

    • v: number

    Returns void

  • get flatRippleColor(): string
  • Gets or sets the color to use for the background when the button is pressed and the type is floating action button.

    Returns string

  • set flatRippleColor(v: string): void
  • Parameters

    • v: string

    Returns void

  • get flatTextColor(): string
  • Gets or sets the color to use for the text of the button when type is flat.

    Returns string

  • set flatTextColor(v: string): void
  • Parameters

    • v: string

    Returns void

  • get flexDirection(): string
  • Gets or sets the id to use for the checkbox.

    Returns string

  • set flexDirection(v: string): void
  • Parameters

    • v: string

    Returns void

  • get flexGrow(): string
  • Gets or sets the flex-grow setting for the button.

    Returns string

  • set flexGrow(v: string): void
  • Parameters

    • v: string

    Returns void

  • get focusBackgroundColor(): string
  • Gets or sets the color to use for the backround the button when it is focused.

    Returns string

  • set focusBackgroundColor(v: string): void
  • Parameters

    • v: string

    Returns void

  • get focusElevation(): number
  • Gets or sets the focus elevation to use for the button regardless of type.

    Returns number

  • set focusElevation(v: number): void
  • Parameters

    • v: number

    Returns void

  • get focusTextColor(): string
  • Gets or sets the color to use for the text of the button when it is focused.

    Returns string

  • set focusTextColor(v: string): void
  • Parameters

    • v: string

    Returns void

  • get focused(): boolean
  • Gets or sets if the checkbox is Focused.

    Returns boolean

  • set focused(v: boolean): void
  • Parameters

    • v: boolean

    Returns void

  • get gotFocus(): EventEmitter<{
        args: IgxFocusEventArgs;
        sender: any;
    }>
  • Returns EventEmitter<{
        args: IgxFocusEventArgs;
        sender: any;
    }>

  • get hoverBackgroundColor(): string
  • Gets or sets the hover color to use for the background of the button when the type is hovered.

    Returns string

  • set hoverBackgroundColor(v: string): void
  • Parameters

    • v: string

    Returns void

  • get hoverElevation(): number
  • Gets or sets the hover elevation to use for the button regardless of type.

    Returns number

  • set hoverElevation(v: number): void
  • Parameters

    • v: number

    Returns void

  • get hoverTextColor(): string
  • Gets or sets the color to use for the hovered text of the button regardless of type.

    Returns string

  • set hoverTextColor(v: string): void
  • Parameters

    • v: string

    Returns void

  • get iconBackgroundColor(): string
  • Gets or sets the color to use for the background of the button when the type is icon.

    Returns string

  • set iconBackgroundColor(v: string): void
  • Parameters

    • v: string

    Returns void

  • get iconBorderColor(): string
  • Gets or sets the border color to use for the button when the type is icon.

    Returns string

  • set iconBorderColor(v: string): void
  • Parameters

    • v: string

    Returns void

  • get iconBorderWidth(): number
  • Gets or sets the width to use for the button border when the type is icon.

    Returns number

  • set iconBorderWidth(v: number): void
  • Parameters

    • v: number

    Returns void

  • get iconCornerRadiusBottomLeft(): number
  • Returns number

  • set iconCornerRadiusBottomLeft(v: number): void
  • Parameters

    • v: number

    Returns void

  • get iconCornerRadiusBottomRight(): number
  • Returns number

  • set iconCornerRadiusBottomRight(v: number): void
  • Parameters

    • v: number

    Returns void

  • get iconCornerRadiusTopLeft(): number
  • Returns number

  • set iconCornerRadiusTopLeft(v: number): void
  • Parameters

    • v: number

    Returns void

  • get iconCornerRadiusTopRight(): number
  • Returns number

  • set iconCornerRadiusTopRight(v: number): void
  • Parameters

    • v: number

    Returns void

  • get iconDisabledBackgroundColor(): string
  • Gets or sets the color to use for the disabled background of the button when the type is icon.

    Returns string

  • set iconDisabledBackgroundColor(v: string): void
  • Parameters

    • v: string

    Returns void

  • get iconDisabledBorderColor(): string
  • Gets or sets the color to use for the disabled border of the button when the type is icon.

    Returns string

  • set iconDisabledBorderColor(v: string): void
  • Parameters

    • v: string

    Returns void

  • get iconDisabledElevation(): number
  • Gets or sets the disabled elevation to use for the button when the type is icon.

    Returns number

  • set iconDisabledElevation(v: number): void
  • Parameters

    • v: number

    Returns void

  • get iconDisabledTextColor(): string
  • Gets or sets the color to use for the disabled text of the button when the type is icon.

    Returns string

  • set iconDisabledTextColor(v: string): void
  • Parameters

    • v: string

    Returns void

  • get iconFocusBackgroundColor(): string
  • Gets or sets the color to use for the backround the button when it is focused and icon.

    Returns string

  • set iconFocusBackgroundColor(v: string): void
  • Parameters

    • v: string

    Returns void

  • get iconFocusElevation(): number
  • Gets or sets the focus elevation to use for the button when the type is icon.

    Returns number

  • set iconFocusElevation(v: number): void
  • Parameters

    • v: number

    Returns void

  • get iconFocusTextColor(): string
  • Gets or sets the color to use for the text the button when it is focused and icon.

    Returns string

  • set iconFocusTextColor(v: string): void
  • Parameters

    • v: string

    Returns void

  • get iconHoverBackgroundColor(): string
  • Gets or sets the hover color to use for the background of the button when the type is hoveredIcon.

    Returns string

  • set iconHoverBackgroundColor(v: string): void
  • Parameters

    • v: string

    Returns void

  • get iconHoverElevation(): number
  • Gets or sets the hover elevation to use for the button when the type is icon.

    Returns number

  • set iconHoverElevation(v: number): void
  • Parameters

    • v: number

    Returns void

  • get iconHoverTextColor(): string
  • Gets or sets the color to use for the hovered text of the button when type is icon.

    Returns string

  • set iconHoverTextColor(v: string): void
  • Parameters

    • v: string

    Returns void

  • get iconRestingElevation(): number
  • Gets or sets the elevation to use for the button when the type is icon.

    Returns number

  • set iconRestingElevation(v: number): void
  • Parameters

    • v: number

    Returns void

  • get iconRippleColor(): string
  • Gets or sets the color to use for the background when the button is pressed and the type is floating action button.

    Returns string

  • set iconRippleColor(v: string): void
  • Parameters

    • v: string

    Returns void

  • get iconTextColor(): string
  • Gets or sets the color to use for the text of the button when type is icon.

    Returns string

  • set iconTextColor(v: string): void
  • Parameters

    • v: string

    Returns void

  • get id(): string
  • Gets or sets the id to use for the checkbox.

    Returns string

  • set id(v: string): void
  • Parameters

    • v: string

    Returns void

  • get inputId(): string
  • Gets or sets the id to use for the internal native checkbox.

    Returns string

  • set inputId(v: string): void
  • Parameters

    • v: string

    Returns void

  • get isFocusStyleEnabled(): boolean
  • Gets or sets if the button show use styling to show focus.

    Returns boolean

  • set isFocusStyleEnabled(v: boolean): void
  • Parameters

    • v: boolean

    Returns void

  • get isHover(): boolean
  • Gets or sets whether the checkbox is checked.

    Returns boolean

  • set isHover(v: boolean): void
  • Parameters

    • v: boolean

    Returns void

  • get lostFocus(): EventEmitter<{
        args: IgxFocusEventArgs;
        sender: any;
    }>
  • Returns EventEmitter<{
        args: IgxFocusEventArgs;
        sender: any;
    }>

  • get minHeight(): number
  • Gets or sets the min height to use for the button.

    Returns number

  • set minHeight(v: number): void
  • Parameters

    • v: number

    Returns void

  • get minWidth(): number
  • Gets or sets the min width to use for the button.

    Returns number

  • set minWidth(v: number): void
  • Parameters

    • v: number

    Returns void

  • get name(): string
  • Gets or sets name to use for the button.

    Returns string

  • set name(v: string): void
  • Parameters

    • v: string

    Returns void

  • get outlinedBackgroundColor(): string
  • Gets or sets the color to use for the background of the button when the type is outlined.

    Returns string

  • set outlinedBackgroundColor(v: string): void
  • Parameters

    • v: string

    Returns void

  • get outlinedBorderColor(): string
  • Gets or sets the border color to use for the button when the type is outlined.

    Returns string

  • set outlinedBorderColor(v: string): void
  • Parameters

    • v: string

    Returns void

  • get outlinedBorderWidth(): number
  • Gets or sets the width to use for the button border when the type is outlined.

    Returns number

  • set outlinedBorderWidth(v: number): void
  • Parameters

    • v: number

    Returns void

  • get outlinedCornerRadiusBottomLeft(): number
  • Returns number

  • set outlinedCornerRadiusBottomLeft(v: number): void
  • Parameters

    • v: number

    Returns void

  • get outlinedCornerRadiusBottomRight(): number
  • Returns number

  • set outlinedCornerRadiusBottomRight(v: number): void
  • Parameters

    • v: number

    Returns void

  • get outlinedCornerRadiusTopLeft(): number
  • Returns number

  • set outlinedCornerRadiusTopLeft(v: number): void
  • Parameters

    • v: number

    Returns void

  • get outlinedCornerRadiusTopRight(): number
  • Returns number

  • set outlinedCornerRadiusTopRight(v: number): void
  • Parameters

    • v: number

    Returns void

  • get outlinedDisabledBackgroundColor(): string
  • Gets or sets the color to use for the disabled background of the button when the type is outlined.

    Returns string

  • set outlinedDisabledBackgroundColor(v: string): void
  • Parameters

    • v: string

    Returns void

  • get outlinedDisabledBorderColor(): string
  • Gets or sets the color to use for the disabled border of the button when the type is outlined.

    Returns string

  • set outlinedDisabledBorderColor(v: string): void
  • Parameters

    • v: string

    Returns void

  • get outlinedDisabledElevation(): number
  • Gets or sets the disabled elevation to use for the button when the type is outlined.

    Returns number

  • set outlinedDisabledElevation(v: number): void
  • Parameters

    • v: number

    Returns void

  • get outlinedDisabledTextColor(): string
  • Gets or sets the color to use for the disabled text of the button when the type is outlined.

    Returns string

  • set outlinedDisabledTextColor(v: string): void
  • Parameters

    • v: string

    Returns void

  • get outlinedFocusBackgroundColor(): string
  • Gets or sets the color to use for the backround the button when it is focused and outlined.

    Returns string

  • set outlinedFocusBackgroundColor(v: string): void
  • Parameters

    • v: string

    Returns void

  • get outlinedFocusElevation(): number
  • Gets or sets the focus elevation to use for the button when the type is outlined.

    Returns number

  • set outlinedFocusElevation(v: number): void
  • Parameters

    • v: number

    Returns void

  • get outlinedFocusTextColor(): string
  • Gets or sets the color to use for the text the button when it is focused and outlined.

    Returns string

  • set outlinedFocusTextColor(v: string): void
  • Parameters

    • v: string

    Returns void

  • get outlinedHoverBackgroundColor(): string
  • Gets or sets the hover color to use for the background of the button when the type is hoveredOutlined.

    Returns string

  • set outlinedHoverBackgroundColor(v: string): void
  • Parameters

    • v: string

    Returns void

  • get outlinedHoverElevation(): number
  • Gets or sets the hover elevation to use for the button when the type is outlined.

    Returns number

  • set outlinedHoverElevation(v: number): void
  • Parameters

    • v: number

    Returns void

  • get outlinedHoverTextColor(): string
  • Gets or sets the color to use for the hovered text of the button when type is outlined.

    Returns string

  • set outlinedHoverTextColor(v: string): void
  • Parameters

    • v: string

    Returns void

  • get outlinedRestingElevation(): number
  • Gets or sets the elevation to use for the button when the type is outlined.

    Returns number

  • set outlinedRestingElevation(v: number): void
  • Parameters

    • v: number

    Returns void

  • get outlinedRippleColor(): string
  • Gets or sets the color to use for the background when the button is pressed and the type is floating action button.

    Returns string

  • set outlinedRippleColor(v: string): void
  • Parameters

    • v: string

    Returns void

  • get outlinedTextColor(): string
  • Gets or sets the color to use for the text of the button when type is outlined.

    Returns string

  • set outlinedTextColor(v: string): void
  • Parameters

    • v: string

    Returns void

  • get raisedBackgroundColor(): string
  • Gets or sets the color to use for the background of the button when the type is raised.

    Returns string

  • set raisedBackgroundColor(v: string): void
  • Parameters

    • v: string

    Returns void

  • get raisedBorderColor(): string
  • Gets or sets the border color to use for the button when the type is raised.

    Returns string

  • set raisedBorderColor(v: string): void
  • Parameters

    • v: string

    Returns void

  • get raisedBorderWidth(): number
  • Gets or sets the width to use for the button border when the type is raised.

    Returns number

  • set raisedBorderWidth(v: number): void
  • Parameters

    • v: number

    Returns void

  • get raisedCornerRadiusBottomLeft(): number
  • Returns number

  • set raisedCornerRadiusBottomLeft(v: number): void
  • Parameters

    • v: number

    Returns void

  • get raisedCornerRadiusBottomRight(): number
  • Returns number

  • set raisedCornerRadiusBottomRight(v: number): void
  • Parameters

    • v: number

    Returns void

  • get raisedCornerRadiusTopLeft(): number
  • Returns number

  • set raisedCornerRadiusTopLeft(v: number): void
  • Parameters

    • v: number

    Returns void

  • get raisedCornerRadiusTopRight(): number
  • Returns number

  • set raisedCornerRadiusTopRight(v: number): void
  • Parameters

    • v: number

    Returns void

  • get raisedDisabledBackgroundColor(): string
  • Gets or sets the color to use for the disabled background of the button when the type is raised.

    Returns string

  • set raisedDisabledBackgroundColor(v: string): void
  • Parameters

    • v: string

    Returns void

  • get raisedDisabledBorderColor(): string
  • Gets or sets the color to use for the disabled border of the button when the type is raised.

    Returns string

  • set raisedDisabledBorderColor(v: string): void
  • Parameters

    • v: string

    Returns void

  • get raisedDisabledElevation(): number
  • Gets or sets the disabled elevation to use for the button when the type is raised.

    Returns number

  • set raisedDisabledElevation(v: number): void
  • Parameters

    • v: number

    Returns void

  • get raisedDisabledTextColor(): string
  • Gets or sets the color to use for the disabled text of the button when the type is raised.

    Returns string

  • set raisedDisabledTextColor(v: string): void
  • Parameters

    • v: string

    Returns void

  • get raisedFocusBackgroundColor(): string
  • Gets or sets the color to use for the backround the button when it is focused and raised.

    Returns string

  • set raisedFocusBackgroundColor(v: string): void
  • Parameters

    • v: string

    Returns void

  • get raisedFocusElevation(): number
  • Gets or sets the focus elevation to use for the button when the type is raised.

    Returns number

  • set raisedFocusElevation(v: number): void
  • Parameters

    • v: number

    Returns void

  • get raisedFocusTextColor(): string
  • Gets or sets the color to use for the text the button when it is focused and raised.

    Returns string

  • set raisedFocusTextColor(v: string): void
  • Parameters

    • v: string

    Returns void

  • get raisedHoverBackgroundColor(): string
  • Gets or sets the hover color to use for the background of the button when the type is raised.

    Returns string

  • set raisedHoverBackgroundColor(v: string): void
  • Parameters

    • v: string

    Returns void

  • get raisedHoverElevation(): number
  • Gets or sets the hover elevation to use for the button when the type is raised.

    Returns number

  • set raisedHoverElevation(v: number): void
  • Parameters

    • v: number

    Returns void

  • get raisedHoverTextColor(): string
  • Gets or sets the color to use for the hovered text of the button when type is raised.

    Returns string

  • set raisedHoverTextColor(v: string): void
  • Parameters

    • v: string

    Returns void

  • get raisedRestingElevation(): number
  • Gets or sets the elevation to use for the button when the type is raised.

    Returns number

  • set raisedRestingElevation(v: number): void
  • Parameters

    • v: number

    Returns void

  • get raisedRippleColor(): string
  • Gets or sets the color to use for the background when the button is pressed and the type is floating action button.

    Returns string

  • set raisedRippleColor(v: string): void
  • Parameters

    • v: string

    Returns void

  • get raisedTextColor(): string
  • Gets or sets the color to use for the text of the button when type is raised.

    Returns string

  • set raisedTextColor(v: string): void
  • Parameters

    • v: string

    Returns void

  • get restingElevation(): number
  • Gets or sets the elevation to use for the button regardless of type.

    Returns number

  • set restingElevation(v: number): void
  • Parameters

    • v: number

    Returns void

  • get rippleColor(): string
  • Gets or sets the color to use for the background of the button regardless of type.

    Returns string

  • set rippleColor(v: string): void
  • Parameters

    • v: string

    Returns void

  • get tabIndex(): number
  • Gets or sets TabIndex to use for the checkbox.

    Returns number

  • set tabIndex(v: number): void
  • Parameters

    • v: number

    Returns void

  • get textColor(): string
  • Gets or sets the color to use for the text of the button regardless of type.

    Returns string

  • set textColor(v: string): void
  • Parameters

    • v: string

    Returns void

  • get textStyle(): string
  • Gets or sets the use for the button.

    Returns string

  • set textStyle(v: string): void
  • Parameters

    • v: string

    Returns void

  • get value(): any
  • Gets or sets value to use for the checkbox.

    Returns any

  • set value(v: any): void
  • Parameters

    • v: any

    Returns void

Methods

  • Returns void

  • Returns void

  • Returns void

  • Returns void

  • Returns void

  • Returns void

  • Returns void

  • Returns a serialized copy of the exported visual model

    Returns string

  • Exports visual information about the current state of the grid.

    Returns any

  • Parameters

    • name: string

    Returns any

  • Returns void

  • Returns void

  • Returns void

  • Returns void

  • Returns void