Ignite UI for Angular

All
  • Public
  • Public/Protected
  • All

Class IgxXCheckboxComponent

Hierarchy

Hierarchy

  • IgxXCheckboxComponent

Implements

  • AfterViewInit

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • Parameters

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

    Returns IgxXCheckboxComponent

Properties

_childTemplateRef

_childTemplateRef: TemplateRef<any>

_dynamicContent

_dynamicContent: ViewContainerRef

container

container: Element

Static ngAcceptInputType_actualBorderWidth

ngAcceptInputType_actualBorderWidth: string | number

Static ngAcceptInputType_actualCornerRadius

ngAcceptInputType_actualCornerRadius: string | number

Static ngAcceptInputType_actualTickStrokeWidth

ngAcceptInputType_actualTickStrokeWidth: string | number

Static ngAcceptInputType_baseTheme

ngAcceptInputType_baseTheme: string | BaseControlTheme

Static ngAcceptInputType_borderWidth

ngAcceptInputType_borderWidth: string | number

Static ngAcceptInputType_checked

ngAcceptInputType_checked: string | boolean

Static ngAcceptInputType_cornerRadius

ngAcceptInputType_cornerRadius: string | number

Static ngAcceptInputType_disableRipple

ngAcceptInputType_disableRipple: string | boolean

Static ngAcceptInputType_disableTransitions

ngAcceptInputType_disableTransitions: string | boolean

Static ngAcceptInputType_disabled

ngAcceptInputType_disabled: string | boolean

Static ngAcceptInputType_focused

ngAcceptInputType_focused: string | boolean

Static ngAcceptInputType_indeterminate

ngAcceptInputType_indeterminate: string | boolean

Static ngAcceptInputType_labelPosition

ngAcceptInputType_labelPosition: string | CheckboxLabelPosition

Static ngAcceptInputType_required

ngAcceptInputType_required: string | number

Static ngAcceptInputType_tabIndex

ngAcceptInputType_tabIndex: string | number

Static ngAcceptInputType_tickStrokeWidth

ngAcceptInputType_tickStrokeWidth: string | number

Static ɵcmp

ɵcmp: unknown

Static ɵfac

ɵfac: unknown

Accessors

actualBorderWidth

  • 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

actualCheckedBackgroundColor

  • get actualCheckedBackgroundColor(): string

  • Gets or sets the color to use for the actual background when the checkbox is checked.

    Returns string

  • set actualCheckedBackgroundColor(v: string): void

  • Parameters

    • v: string

    Returns void

actualCheckedBorderColor

  • get actualCheckedBorderColor(): string

  • Gets or sets the color to use for the check mark when the checkbox is checked.

    Returns string

  • set actualCheckedBorderColor(v: string): void

  • Parameters

    • v: string

    Returns void

actualCornerRadius

  • get actualCornerRadius(): number

  • Gets the actual corner radius to use for the checkbox.

    Returns number

  • set actualCornerRadius(v: number): void

  • Parameters

    • v: number

    Returns void

actualTickColor

  • get actualTickColor(): string

  • Gets or sets the color to use for the check mark when the checkbox is checked.

    Returns string

  • set actualTickColor(v: string): void

  • Parameters

    • v: string

    Returns void

actualTickStrokeWidth

  • get actualTickStrokeWidth(): number

  • Gets or sets the stroke width to use for the check mark.

    Returns number

  • set actualTickStrokeWidth(v: number): void

  • Parameters

    • v: number

    Returns void

actualUncheckedBackgroundColor

  • get actualUncheckedBackgroundColor(): string

  • Gets or sets the color to use for the actual background when the checkbox is unchecked.

    Returns string

  • set actualUncheckedBackgroundColor(v: string): void

  • Parameters

    • v: string

    Returns void

actualUncheckedBorderColor

  • get actualUncheckedBorderColor(): string

  • Gets or sets the color to use for the check mark when the checkbox is checked.

    Returns string

  • set actualUncheckedBorderColor(v: string): void

  • Parameters

    • v: string

    Returns void

ariaLabel

  • 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

ariaLabelledBy

  • get ariaLabelledBy(): string

  • Gets or sets the value of the aria-labelledby attribute.

    Returns string

  • set ariaLabelledBy(v: string): void

  • Parameters

    • v: string

    Returns void

baseTheme

  • get baseTheme(): BaseControlTheme

  • Gets or sets the base built in theme to use for the checkbox.

    Returns BaseControlTheme

  • set baseTheme(v: BaseControlTheme): void

  • Parameters

    Returns void

borderWidth

  • get borderWidth(): number

  • Gets or sets the Width to use for the check mark when the checkbox is checked.

    Returns number

  • set borderWidth(v: number): void

  • Parameters

    • v: number

    Returns void

change

checked

  • get checked(): boolean

  • Gets or sets whether the checkbox is checked.

    Returns boolean

  • set checked(v: boolean): void

  • Parameters

    • v: boolean

    Returns void

checkedBackgroundColor

  • get checkedBackgroundColor(): string

  • Gets or sets the color to use for the background when the checkbox is checked.

    Returns string

  • set checkedBackgroundColor(v: string): void

  • Parameters

    • v: string

    Returns void

checkedBorderColor

  • get checkedBorderColor(): string

  • Gets or sets the color to use for the check mark when the checkbox is checked.

    Returns string

  • set checkedBorderColor(v: string): void

  • Parameters

    • v: string

    Returns void

cornerRadius

  • get cornerRadius(): number

  • Gets or sets the corner radius to use for the checkbox.

    Returns number

  • set cornerRadius(v: number): void

  • Parameters

    • v: number

    Returns void

disableRipple

  • get disableRipple(): boolean

  • Gets or sets whether to disable the ripple effect for the checkbox.

    Returns boolean

  • set disableRipple(v: boolean): void

  • Parameters

    • v: boolean

    Returns void

disableTransitions

  • get disableTransitions(): boolean

  • Gets or sets whether the checkbox transitions are disabled.

    Returns boolean

  • set disableTransitions(v: boolean): void

  • Parameters

    • v: boolean

    Returns void

disabled

  • get disabled(): boolean

  • Gets or sets whether the checkbox is disabled.

    Returns boolean

  • set disabled(v: boolean): void

  • Parameters

    • v: boolean

    Returns void

focused

  • get focused(): boolean

  • Gets or sets if the checkbox is Focused.

    Returns boolean

  • set focused(v: boolean): void

  • Parameters

    • v: boolean

    Returns void

i

  • get i(): XCheckbox

  • Returns XCheckbox

id

  • 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

indeterminate

  • get indeterminate(): boolean

  • Gets or sets whether the checkbox is indeterminate.

    Returns boolean

  • set indeterminate(v: boolean): void

  • Parameters

    • v: boolean

    Returns void

inputId

  • 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

labelId

  • get labelId(): string

  • Gets or sets id to use for the checkbox label.

    Returns string

  • set labelId(v: string): void

  • Parameters

    • v: string

    Returns void

labelPosition

  • get labelPosition(): CheckboxLabelPosition

  • Gets or sets LabelPosition to use for the checkbox.

    Returns CheckboxLabelPosition

  • set labelPosition(v: CheckboxLabelPosition): void

  • Parameters

    • v: CheckboxLabelPosition

    Returns void

name

  • get name(): string

  • Gets or sets name to use for the checkbox.

    Returns string

  • set name(v: string): void

  • Parameters

    • v: string

    Returns void

required

  • get required(): number

  • Gets or sets if the checkbox is required.

    Returns number

  • set required(v: number): void

  • Parameters

    • v: number

    Returns void

tabIndex

  • get tabIndex(): number

  • Gets or sets TabIndex to use for the checkbox.

    Returns number

  • set tabIndex(v: number): void

  • Parameters

    • v: number

    Returns void

tickColor

  • get tickColor(): string

  • Gets or sets the color to use for the check mark when the checkbox is checked.

    Returns string

  • set tickColor(v: string): void

  • Parameters

    • v: string

    Returns void

tickStrokeWidth

  • get tickStrokeWidth(): number

  • Gets or sets the corner radius to use for the checkbox.

    Returns number

  • set tickStrokeWidth(v: number): void

  • Parameters

    • v: number

    Returns void

uncheckedBackgroundColor

  • get uncheckedBackgroundColor(): string

  • Gets or sets the color to use for the background when the checkbox is unchecked.

    Returns string

  • set uncheckedBackgroundColor(v: string): void

  • Parameters

    • v: string

    Returns void

uncheckedBorderColor

  • get uncheckedBorderColor(): string

  • Gets or sets the color to use for the check mark when the checkbox is unchecked.

    Returns string

  • set uncheckedBorderColor(v: string): void

  • Parameters

    • v: string

    Returns void

value

  • 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

exportSerializedVisualModel

  • Returns a serialized copy of the exported visual model

    Returns string

exportVisualModel

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

    Returns any

findByName

  • Parameters

    • name: string

    Returns any

ngAfterViewInit

  • Returns void

ngOnDestroy

  • Returns void

onAttachedToUI

  • Returns void

onDetachedFromUI

  • Returns void

updateStyle

  • Returns void