Ignite UI for Angular

Index

Enumerations

Classes

Interfaces

Type Aliases

Variables

Functions

Type Aliases

ButtonGroupAlignment: typeof ButtonGroupAlignment[keyof typeof ButtonGroupAlignment]
CalendarSelection: typeof CalendarSelection[keyof typeof CalendarSelection]
CarouselIndicatorsOrientation: typeof CarouselIndicatorsOrientation[keyof typeof CarouselIndicatorsOrientation]
ColumnDisplayOrder: typeof ColumnDisplayOrder[keyof typeof ColumnDisplayOrder]
DisplayDensity: typeof DisplayDensity[keyof typeof DisplayDensity]
ExpansionPanelHeaderIconPosition: typeof ExpansionPanelHeaderIconPosition[keyof typeof ExpansionPanelHeaderIconPosition]
FilterMode: typeof FilterMode[keyof typeof FilterMode]
GridColumnDataType: typeof GridColumnDataType[keyof typeof GridColumnDataType]
GridFeatures: keyof IGridStateOptions
GridKeydownTargetType: "dataCell" | "summaryCell" | "groupRow" | "hierarchicalRow" | "headerCell" | "masterDetailRow"
GridSelectionMode: typeof GridSelectionMode[keyof typeof GridSelectionMode]
GridSummaryCalculationMode: typeof GridSummaryCalculationMode[keyof typeof GridSummaryCalculationMode]
GridSummaryPosition: typeof GridSummaryPosition[keyof typeof GridSummaryPosition]
HorizontalAnimationType: typeof HorizontalAnimationType[keyof typeof HorizontalAnimationType]
IgxAvatarSize: typeof IgxAvatarSize[keyof typeof IgxAvatarSize]
IgxAvatarType: typeof IgxAvatarType[keyof typeof IgxAvatarType]
IgxBadgeType: typeof IgxBadgeType[keyof typeof IgxBadgeType]
IgxButtonType: typeof IgxButtonType[keyof typeof IgxButtonType]

Determines the Button type.

IgxCalendarView: typeof IgxCalendarView[keyof typeof IgxCalendarView] | CalendarView

Determines the Calendar active view - days, months or years.

IgxCardActionsLayout: typeof IgxCardActionsLayout[keyof typeof IgxCardActionsLayout]
IgxCardType: typeof IgxCardType[keyof typeof IgxCardType]
IgxDividerType: typeof IgxDividerType[keyof typeof IgxDividerType]
IgxInputGroupTheme: typeof IgxInputGroupTheme[keyof typeof IgxInputGroupTheme]

Determines the Input Group theme.

IgxInputGroupType: typeof IgxInputGroupEnum[keyof typeof IgxInputGroupEnum]

Determines the InputGroupType.

IgxProgressType: typeof IgxProgressType[keyof typeof IgxProgressType]
IgxSliderType: typeof IgxSliderType[keyof typeof IgxSliderType]
IgxStepType: typeof IgxStepType[keyof typeof IgxStepType]
IgxStepperOrientation: typeof IgxStepperOrientation[keyof typeof IgxStepperOrientation]
IgxStepperTitlePosition: typeof IgxStepperTitlePosition[keyof typeof IgxStepperTitlePosition]
IgxTabsAlignment: typeof IgxTabsAlignment[keyof typeof IgxTabsAlignment]
IgxTextAlign: typeof IgxTextAlign[keyof typeof IgxTextAlign]
IgxTreeSearchResolver: ((data: any, node: IgxTreeNode<any>) => boolean)

Type declaration

    • Comparer function that can be used when searching through IgxTreeNode[]

      Parameters

      Returns boolean

IgxTreeSelectionType: typeof IgxTreeSelectionType[keyof typeof IgxTreeSelectionType]
LabelPosition: typeof LabelPosition[keyof typeof LabelPosition]
PickerInteractionMode: typeof PickerInteractionMode[keyof typeof PickerInteractionMode]
PivotAggregation: ((members: any[], data: any[]) => any)

Type declaration

    • (members: any[], data: any[]): any
    • Interface describing a PivotAggregation function. Accepts an array of extracted data members and a array of the original data records.

      Parameters

      • members: any[]
      • data: any[]

      Returns any

RadioGroupAlignment: typeof RadioGroupAlignment[keyof typeof RadioGroupAlignment]
RadioLabelPosition: typeof RadioLabelPosition[keyof typeof RadioLabelPosition]
SliderHandle: typeof SliderHandle[keyof typeof SliderHandle]
SwitchLabelPosition: typeof SwitchLabelPosition[keyof typeof SwitchLabelPosition]
TickLabelsOrientation: typeof TickLabelsOrientation[keyof typeof TickLabelsOrientation]
TicksOrientation: typeof TicksOrientation[keyof typeof TicksOrientation]
VerticalAnimationType: typeof VerticalAnimationType[keyof typeof VerticalAnimationType]

Variables

ButtonGroupAlignment: { horizontal: "horizontal"; vertical: "vertical" } = ...

Determines the Button Group alignment

Type declaration

  • horizontal: "horizontal"
  • vertical: "vertical"
CalendarSelection: { MULTI: "multi"; RANGE: "range"; SINGLE: "single" } = ...

Sets the selection type - single, multi or range.

Type declaration

  • MULTI: "multi"
  • RANGE: "range"
  • SINGLE: "single"
CarouselIndicatorsOrientation: { bottom: "bottom"; top: "top" } = ...

Type declaration

  • bottom: "bottom"
  • top: "top"
ColumnDisplayOrder: { Alphabetical: "Alphabetical"; DisplayOrder: "DisplayOrder" } = ...

Type declaration

  • Alphabetical: "Alphabetical"
  • DisplayOrder: "DisplayOrder"
DEFAULT_OWNER: "default" = 'default'
DEFAULT_PIVOT_KEYS: { aggregations: string; children: string; columnDimensionSeparator: string; level: string; records: string; rowDimensionSeparator: string } = ...

Default pivot keys used for data processing in the pivot pipes.

Type declaration

  • aggregations: string
  • children: string
  • columnDimensionSeparator: string
  • level: string
  • records: string
  • rowDimensionSeparator: string
DisplayDensity: { comfortable: "comfortable"; compact: "compact"; cosy: "cosy" } = ...

Defines the possible values of the components' display density.

Type declaration

  • comfortable: "comfortable"
  • compact: "compact"
  • cosy: "cosy"
DisplayDensityToken: InjectionToken<IDisplayDensityOptions> = ...

Defines the DisplayDensity DI token.

FilterMode: { excelStyleFilter: "excelStyleFilter"; quickFilter: "quickFilter" } = ...

Type declaration

  • excelStyleFilter: "excelStyleFilter"
  • quickFilter: "quickFilter"
GridSelectionMode: { multiple: "multiple"; multipleCascade: "multipleCascade"; none: "none"; single: "single" } = ...

Type declaration

  • multiple: "multiple"
  • multipleCascade: "multipleCascade"
  • none: "none"
  • single: "single"
GridSummaryCalculationMode: { childLevelsOnly: "childLevelsOnly"; rootAndChildLevels: "rootAndChildLevels"; rootLevelOnly: "rootLevelOnly" } = ...

Type declaration

  • childLevelsOnly: "childLevelsOnly"
  • rootAndChildLevels: "rootAndChildLevels"
  • rootLevelOnly: "rootLevelOnly"
GridSummaryPosition: { bottom: "bottom"; top: "top" } = ...

Type declaration

  • bottom: "bottom"
  • top: "top"
HorizontalAnimationType: { fade: "fade"; none: "none"; slide: "slide" } = ...

Type declaration

  • fade: "fade"
  • none: "none"
  • slide: "slide"
IGX_CHECKBOX_REQUIRED_VALIDATOR: Provider = ...
IGX_GRID_BASE: InjectionToken<GridType> = ...
IGX_INPUT_GROUP_TYPE: InjectionToken<IgxInputGroupType> = ...

Defines the InputGroupType DI token.

IGX_STEPPER_COMPONENT: InjectionToken<IgxStepperComponent> = ...
IGX_STEP_COMPONENT: InjectionToken<IgxStepComponent> = ...
IGX_SWITCH_REQUIRED_VALIDATOR: Provider = ...
IgxAvatarSize: { LARGE: "large"; MEDIUM: "medium"; SMALL: "small" } = ...

Type declaration

  • LARGE: "large"
  • MEDIUM: "medium"
  • SMALL: "small"
IgxAvatarType: { CUSTOM: "custom"; ICON: "icon"; IMAGE: "image"; INITIALS: "initials" } = ...

Type declaration

  • CUSTOM: "custom"
  • ICON: "icon"
  • IMAGE: "image"
  • INITIALS: "initials"
IgxBadgeType: { ERROR: "error"; INFO: "info"; PRIMARY: "primary"; SUCCESS: "success"; WARNING: "warning" } = ...

Determines the igxBadge type

Type declaration

  • ERROR: "error"
  • INFO: "info"
  • PRIMARY: "primary"
  • SUCCESS: "success"
  • WARNING: "warning"
IgxCalendarView: { Decade: "decade"; Month: "month"; Year: "year" } = ...

Type declaration

  • Decade: "decade"
  • Month: "month"
  • Year: "year"
IgxCardActionsLayout: { JUSTIFY: "justify"; START: "start" } = ...

Type declaration

  • JUSTIFY: "justify"
  • START: "start"
IgxCardType: { ELEVATED: "elevated"; OUTLINED: "outlined" } = ...

Card provides a way to display organized content in appealing way.

igxmodule

IgxCardModule

igxtheme

igx-card-theme, igx-icon-theme, igx-button-theme

igxkeywords

card, button, avatar, icon

igxgroup

Layouts

remarks

The Ignite UI Card serves as a container that allows custom content to be organized in an appealing way. There are five sections in a card that you can use to organize your content. These are header, media, content, actions, and footer.

example
<igx-card>
<igx-card-header>
<h3 igxCardHeaderTitle>{{title}}</h3>
<h5 igxCardHeaderSubtitle>{{subtitle}}</h5>
</igx-card-header>
<igx-card-actions>
<button igxButton igxRipple>Share</button>
<button igxButton igxRipple>Play Album</button>
</igx-card-actions>
</igx-card>

Type declaration

  • ELEVATED: "elevated"
  • OUTLINED: "outlined"
IgxDividerType: { DASHED: "dashed"; SOLID: "solid" } = ...

Type declaration

  • DASHED: "dashed"
  • SOLID: "solid"
IgxHierarchicalTransactionServiceFactory: { provide: InjectionToken<string>; useFactory: (() => IgxTransactionService<Transaction, State>) } = ...

Type declaration

IgxProgressType: { ERROR: "error"; INFO: "info"; SUCCESS: "success"; WARNING: "warning" } = ...

Type declaration

  • ERROR: "error"
  • INFO: "info"
  • SUCCESS: "success"
  • WARNING: "warning"
IgxSliderType: { RANGE: "range"; SLIDER: "slider" } = ...

Type declaration

  • RANGE: "range"

    Range slider with multiple thumbs, that can mark the range.

  • SLIDER: "slider"

    Slider with single thumb.

IgxStepType: { Full: "full"; Indicator: "indicator"; Title: "title" } = ...

Type declaration

  • Full: "full"
  • Indicator: "indicator"
  • Title: "title"
IgxStepperOrientation: { Horizontal: "horizontal"; Vertical: "vertical" } = ...

Type declaration

  • Horizontal: "horizontal"
  • Vertical: "vertical"
IgxStepperTitlePosition: { Bottom: "bottom"; End: "end"; Start: "start"; Top: "top" } = ...

Type declaration

  • Bottom: "bottom"
  • End: "end"
  • Start: "start"
  • Top: "top"
IgxTabsAlignment: { center: "center"; end: "end"; justify: "justify"; start: "start" } = ...

Type declaration

  • center: "center"
  • end: "end"
  • justify: "justify"
  • start: "start"
IgxTextAlign: { CENTER: "center"; END: "end"; START: "start" } = ...

Type declaration

  • CENTER: "center"
  • END: "end"
  • START: "start"
IgxTreeSelectionType: { BiState: "BiState"; Cascading: "Cascading"; None: "None" } = ...

Type declaration

  • BiState: "BiState"
  • Cascading: "Cascading"
  • None: "None"
LabelPosition: { AFTER: "after"; BEFORE: "before" } = ...

Type declaration

  • AFTER: "after"
  • BEFORE: "before"
PickerInteractionMode: { Dialog: "dialog"; DropDown: "dropdown" } = ...

This enumeration is used to configure whether the date/time picker has an editable input with drop down or is readonly - the date/time is selected only through a dialog.

Type declaration

  • Dialog: "dialog"
  • DropDown: "dropdown"
RadioGroupAlignment: { horizontal: "horizontal"; vertical: "vertical" } = ...

Determines the Radio Group alignment

Type declaration

  • horizontal: "horizontal"
  • vertical: "vertical"
RadioLabelPosition: { AFTER: "after"; BEFORE: "before" } = ...

Type declaration

  • AFTER: "after"
  • BEFORE: "before"
SPLITTER_INTERACTION_KEYS: Set<string> = ...
SliderHandle: { FROM: "from"; TO: "to" } = ...

Type declaration

  • FROM: "from"
  • TO: "to"
SwitchLabelPosition: { AFTER: "after"; BEFORE: "before" } = ...

Type declaration

  • AFTER: "after"
  • BEFORE: "before"
TickLabelsOrientation: { BottomToTop: "bottomtotop"; Horizontal: "horizontal"; TopToBottom: "toptobottom" } = ...

Slider Tick labels Orientation

Type declaration

  • BottomToTop: "bottomtotop"
  • Horizontal: "horizontal"
  • TopToBottom: "toptobottom"
TicksOrientation: { Bottom: "bottom"; Mirror: "mirror"; Top: "top" } = ...

Slider Ticks orientation

Type declaration

  • Bottom: "bottom"
  • Mirror: "mirror"
  • Top: "top"
VerticalAnimationType: { Fade: "fade"; Grow: "grow"; None: "none" } = ...

Type declaration

  • Fade: "fade"
  • Grow: "grow"
  • None: "none"
blink: AnimationReferenceMetadata = ...
fadeIn: AnimationReferenceMetadata = ...
fadeOut: AnimationReferenceMetadata = ...
filteringStateDefaults: { strategy: FilteringStrategy } = ...

Type declaration

flipBottom: AnimationReferenceMetadata = ...
flipHorBck: AnimationReferenceMetadata = ...
flipHorFwd: AnimationReferenceMetadata = ...
flipLeft: AnimationReferenceMetadata = ...
flipRight: AnimationReferenceMetadata = ...
flipTop: AnimationReferenceMetadata = ...
flipVerBck: AnimationReferenceMetadata = ...
flipVerFwd: AnimationReferenceMetadata = ...
growVerIn: AnimationReferenceMetadata = ...
growVerOut: AnimationReferenceMetadata = ...
heartbeat: AnimationReferenceMetadata = ...
pulsateBck: AnimationReferenceMetadata = ...
pulsateFwd: AnimationReferenceMetadata = ...
rotateInBl: AnimationReferenceMetadata = ...
rotateInBottom: AnimationReferenceMetadata = ...
rotateInBr: AnimationReferenceMetadata = ...
rotateInCenter: AnimationReferenceMetadata = ...
rotateInDiagonal1: AnimationReferenceMetadata = ...
rotateInDiagonal2: AnimationReferenceMetadata = ...
rotateInHor: AnimationReferenceMetadata = ...
rotateInLeft: AnimationReferenceMetadata = ...
rotateInRight: AnimationReferenceMetadata = ...
rotateInTl: AnimationReferenceMetadata = ...
rotateInTop: AnimationReferenceMetadata = ...
rotateInTr: AnimationReferenceMetadata = ...
rotateInVer: AnimationReferenceMetadata = ...
rotateOutBl: AnimationReferenceMetadata = ...
rotateOutBottom: AnimationReferenceMetadata = ...
rotateOutBr: AnimationReferenceMetadata = ...
rotateOutCenter: AnimationReferenceMetadata = ...
rotateOutDiagonal1: AnimationReferenceMetadata = ...
rotateOutDiagonal2: AnimationReferenceMetadata = ...
rotateOutHor: AnimationReferenceMetadata = ...
rotateOutLeft: AnimationReferenceMetadata = ...
rotateOutRight: AnimationReferenceMetadata = ...
rotateOutTl: AnimationReferenceMetadata = ...
rotateOutTop: AnimationReferenceMetadata = ...
rotateOutTr: AnimationReferenceMetadata = ...
rotateOutVer: AnimationReferenceMetadata = ...
scaleInBl: AnimationReferenceMetadata = ...
scaleInBottom: AnimationReferenceMetadata = ...
scaleInBr: AnimationReferenceMetadata = ...
scaleInCenter: AnimationReferenceMetadata = ...
scaleInHorCenter: AnimationReferenceMetadata = ...
scaleInHorLeft: AnimationReferenceMetadata = ...
scaleInHorRight: AnimationReferenceMetadata = ...
scaleInLeft: AnimationReferenceMetadata = ...
scaleInRight: AnimationReferenceMetadata = ...
scaleInTl: AnimationReferenceMetadata = ...
scaleInTop: AnimationReferenceMetadata = ...
scaleInTr: AnimationReferenceMetadata = ...
scaleInVerBottom: AnimationReferenceMetadata = ...
scaleInVerCenter: AnimationReferenceMetadata = ...
scaleInVerTop: AnimationReferenceMetadata = ...
scaleOutBl: AnimationReferenceMetadata = ...
scaleOutBottom: AnimationReferenceMetadata = ...
scaleOutBr: AnimationReferenceMetadata = ...
scaleOutCenter: AnimationReferenceMetadata = ...
scaleOutHorCenter: AnimationReferenceMetadata = ...
scaleOutHorLeft: AnimationReferenceMetadata = ...
scaleOutHorRight: AnimationReferenceMetadata = ...
scaleOutLeft: AnimationReferenceMetadata = ...
scaleOutRight: AnimationReferenceMetadata = ...
scaleOutTl: AnimationReferenceMetadata = ...
scaleOutTop: AnimationReferenceMetadata = ...
scaleOutTr: AnimationReferenceMetadata = ...
scaleOutVerBottom: AnimationReferenceMetadata = ...
scaleOutVerCenter: AnimationReferenceMetadata = ...
scaleOutVerTop: AnimationReferenceMetadata = ...
shakeBl: AnimationReferenceMetadata = ...
shakeBottom: AnimationReferenceMetadata = ...
shakeBr: AnimationReferenceMetadata = ...
shakeCenter: AnimationReferenceMetadata = ...
shakeHor: AnimationReferenceMetadata = ...
shakeLeft: AnimationReferenceMetadata = ...
shakeRight: AnimationReferenceMetadata = ...
shakeTl: AnimationReferenceMetadata = ...
shakeTop: AnimationReferenceMetadata = ...
shakeTr: AnimationReferenceMetadata = ...
shakeVer: AnimationReferenceMetadata = ...
slideInBl: AnimationReferenceMetadata = ...
slideInBottom: AnimationReferenceMetadata = ...
slideInBr: AnimationReferenceMetadata = ...
slideInLeft: AnimationReferenceMetadata = ...
slideInRight: AnimationReferenceMetadata = ...
slideInTl: AnimationReferenceMetadata = ...
slideInTop: AnimationReferenceMetadata = ...
slideInTr: AnimationReferenceMetadata = ...
slideOutBl: AnimationReferenceMetadata = ...
slideOutBottom: AnimationReferenceMetadata = ...
slideOutBr: AnimationReferenceMetadata = ...
slideOutLeft: AnimationReferenceMetadata = ...
slideOutRight: AnimationReferenceMetadata = ...
slideOutTl: AnimationReferenceMetadata = ...
slideOutTop: AnimationReferenceMetadata = ...
slideOutTr: AnimationReferenceMetadata = ...
swingInBottomBck: AnimationReferenceMetadata = ...
swingInBottomFwd: AnimationReferenceMetadata = ...
swingInLeftBck: AnimationReferenceMetadata = ...
swingInLeftFwd: AnimationReferenceMetadata = ...
swingInRightBck: AnimationReferenceMetadata = ...
swingInRightFwd: AnimationReferenceMetadata = ...
swingInTopBck: AnimationReferenceMetadata = ...
swingInTopFwd: AnimationReferenceMetadata = ...
swingOutBottomBck: AnimationReferenceMetadata = ...
swingOutBottomFwd: AnimationReferenceMetadata = ...
swingOutLeftBck: AnimationReferenceMetadata = ...
swingOutLefttFwd: AnimationReferenceMetadata = ...
swingOutRightBck: AnimationReferenceMetadata = ...
swingOutRightFwd: AnimationReferenceMetadata = ...
swingOutTopBck: AnimationReferenceMetadata = ...
swingOutTopFwd: AnimationReferenceMetadata = ...

Functions

  • getTypeNameForDebugging(type: any): string
  • isLeap(year: number): boolean
  • monthRange(year: number, month: number): number[]
  • range(start?: number, stop: any, step?: number): any[]
  • toPercent(value: number, max: number): number
  • toValue(value: number, max: number): number
  • valueInRange(value: number, max: number, min?: number): number
  • weekDay(year: number, month: number, day: number): number