Ignite UI for Angular

All
  • Public
  • Public/Protected
  • All

Class IgxToolbarComponent

Hierarchy

Hierarchy

  • IgxToolbarComponent

Implements

  • AfterContentInit

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • Parameters

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

    Returns IgxToolbarComponent

Properties

_childTemplateRef

_childTemplateRef: TemplateRef<any>

_dynamicContent

_dynamicContent: ViewContainerRef

_mainDiv

_mainDiv: Element

_mainDivRef

_mainDivRef: ElementRef<any>

combinedActions

combinedActions: IgxToolActionComponent[]

The style mappings actually present in the chart. Do not directly modify this array. This array's contents can be modified by causing Angular to reproject the child content. Or adding and removing stye mappings from the manual style mapping collection on the actions property.

contentActions

contentActions: QueryList<IgxToolActionComponent>

Static ngAcceptInputType_actualActions

ngAcceptInputType_actualActions: string | IgxToolActionCollection

Static ngAcceptInputType_autoGeneratedActions

ngAcceptInputType_autoGeneratedActions: string | IgxToolActionCollection

Static ngAcceptInputType_baseTheme

ngAcceptInputType_baseTheme: string | BaseControlTheme

Static ngAcceptInputType_density

ngAcceptInputType_density: string | ControlDisplayDensity

Static ngAcceptInputType_dropdownClickBuffer

ngAcceptInputType_dropdownClickBuffer: string | number

Static ngAcceptInputType_dropdownDelay

ngAcceptInputType_dropdownDelay: string | number

Static ngAcceptInputType_highlightRadius

ngAcceptInputType_highlightRadius: string | number

Static ngAcceptInputType_highlightWidth

ngAcceptInputType_highlightWidth: string | number

Static ngAcceptInputType_isOpen

ngAcceptInputType_isOpen: string | boolean

Static ngAcceptInputType_orientation

ngAcceptInputType_orientation: string | ToolbarOrientation

Static ngAcceptInputType_rowHeight

ngAcceptInputType_rowHeight: string | number

Static ngAcceptInputType_scrollbarStyle

ngAcceptInputType_scrollbarStyle: string | ScrollbarStyle

Static ngAcceptInputType_separatorHorizontalPaddingBottom

ngAcceptInputType_separatorHorizontalPaddingBottom: string | number

Static ngAcceptInputType_separatorHorizontalPaddingLeft

ngAcceptInputType_separatorHorizontalPaddingLeft: string | number

Static ngAcceptInputType_separatorHorizontalPaddingRight

ngAcceptInputType_separatorHorizontalPaddingRight: string | number

Static ngAcceptInputType_separatorHorizontalPaddingTop

ngAcceptInputType_separatorHorizontalPaddingTop: string | number

Static ngAcceptInputType_separatorVerticalPaddingBottom

ngAcceptInputType_separatorVerticalPaddingBottom: string | number

Static ngAcceptInputType_separatorVerticalPaddingLeft

ngAcceptInputType_separatorVerticalPaddingLeft: string | number

Static ngAcceptInputType_separatorVerticalPaddingRight

ngAcceptInputType_separatorVerticalPaddingRight: string | number

Static ngAcceptInputType_separatorVerticalPaddingTop

ngAcceptInputType_separatorVerticalPaddingTop: string | number

Static ngAcceptInputType_showOnHover

ngAcceptInputType_showOnHover: string | boolean

Static ngAcceptInputType_showTooltipOnHover

ngAcceptInputType_showTooltipOnHover: string | boolean

Static ngAcceptInputType_stopPropagation

ngAcceptInputType_stopPropagation: string | boolean

Static ngAcceptInputType_toolTipCornerRadius

ngAcceptInputType_toolTipCornerRadius: string | number

Static ngAcceptInputType_toolTipElevation

ngAcceptInputType_toolTipElevation: string | number

Static ɵcmp

ɵcmp: unknown

Static ɵfac

ɵfac: unknown

Accessors

actions

actualActions

autoGeneratedActions

backgroundColor

  • get backgroundColor(): string

  • Gets or sets the color to use for the background of the component.

    Returns string

  • set backgroundColor(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

cellTextStyle

  • get cellTextStyle(): string

  • Gets or sets the text style.

    Returns string

  • set cellTextStyle(v: string): void

  • Parameters

    • v: string

    Returns void

checkedBackgroundColor

  • get checkedBackgroundColor(): string

  • Gets or sets the background color of the radio when in the checked state.

    Returns string

  • set checkedBackgroundColor(v: string): void

  • Parameters

    • v: string

    Returns void

checkedBorderColor

  • get checkedBorderColor(): string

  • Gets or sets the border color of the radio when in the checked state.

    Returns string

  • set checkedBorderColor(v: string): void

  • Parameters

    • v: string

    Returns void

density

disabledTextColor

  • get disabledTextColor(): string

  • Gets or sets the color to use for the text in disabled tool actions.

    Returns string

  • set disabledTextColor(v: string): void

  • Parameters

    • v: string

    Returns void

dropdownClickBuffer

  • Gets or sets the amount of time to wait when clicking on the icon menu button while the dropdown is opening. If a click was executed within this buffer window the dropdown will be left open. Otherwise it will close it. Setting a negative value will always keep the dropdown open during a hover open and will require an extra click to close.

    Returns number

  • Parameters

    • v: number

    Returns void

dropdownDelay

  • Gets or sets the dropdown delay time in milliseconds.

    Returns number

  • Parameters

    • v: number

    Returns void

groupHeaderBackgroundColor

  • get groupHeaderBackgroundColor(): string

  • Gets or sets the group header background color.

    Returns string

  • set groupHeaderBackgroundColor(v: string): void

  • Parameters

    • v: string

    Returns void

groupHeaderSubtitleTextColor

  • get groupHeaderSubtitleTextColor(): string

  • Gets or sets the text color for group header subtitles.

    Returns string

  • set groupHeaderSubtitleTextColor(v: string): void

  • Parameters

    • v: string

    Returns void

groupHeaderTextColor

  • get groupHeaderTextColor(): string

  • Gets or sets the text color for group header tool actions.

    Returns string

  • set groupHeaderTextColor(v: string): void

  • Parameters

    • v: string

    Returns void

groupHeaderTextStyle

  • get groupHeaderTextStyle(): string

  • Gets or sets the text style.

    Returns string

  • set groupHeaderTextStyle(v: string): void

  • Parameters

    • v: string

    Returns void

height

  • get height(): string

  • Returns string

  • set height(value: string): void

  • Parameters

    • value: string

    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

hoverBackgroundColor

  • get hoverBackgroundColor(): string

  • Gets or sets the hover background color.

    Returns string

  • set hoverBackgroundColor(v: string): void

  • Parameters

    • v: string

    Returns void

i

  • get i(): Toolbar

  • Returns Toolbar

iconFill

  • get iconFill(): string

  • Gets or sets the fill color of icons in the ToolPanel.

    Returns string

  • set iconFill(v: string): void

  • Parameters

    • v: string

    Returns void

iconStroke

  • get iconStroke(): string

  • Gets or sets the stroke color of icons in the ToolPanel.

    Returns string

  • set iconStroke(v: string): void

  • Parameters

    • v: string

    Returns void

isOpen

  • get isOpen(): boolean

  • Returns boolean

menuArrowStroke

  • Gets or sets the stroke color for all icon menu dropdown arrows.

    Returns string

  • Parameters

    • v: string

    Returns void

onCommand

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

  • Event raised when a command is triggered in the toolbar.

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

orientation

rowHeight

  • get rowHeight(): number

  • Gets or sets the row height that should be used.

    Returns number

  • set rowHeight(v: number): void

  • Parameters

    • v: number

    Returns void

scrollbarStyle

  • get scrollbarStyle(): ScrollbarStyle

  • Gets or sets the style of scrollbar.

    Returns ScrollbarStyle

  • set scrollbarStyle(v: ScrollbarStyle): void

  • Parameters

    Returns void

separatorBackgroundColor

  • get separatorBackgroundColor(): string

  • Gets or sets the separator background color.

    Returns string

  • set separatorBackgroundColor(v: string): void

  • Parameters

    • v: string

    Returns void

separatorHorizontalPaddingBottom

  • get separatorHorizontalPaddingBottom(): number

  • Gets or sets the bottom padding for separators in the horizontal orientation.

    Returns number

  • set separatorHorizontalPaddingBottom(v: number): void

  • Parameters

    • v: number

    Returns void

separatorHorizontalPaddingLeft

  • get separatorHorizontalPaddingLeft(): number

  • Gets or sets the left padding for separators in the horizontal orientation.

    Returns number

  • set separatorHorizontalPaddingLeft(v: number): void

  • Parameters

    • v: number

    Returns void

separatorHorizontalPaddingRight

  • get separatorHorizontalPaddingRight(): number

  • Gets or sets the right padding for separators in the horizontal orientation.

    Returns number

  • set separatorHorizontalPaddingRight(v: number): void

  • Parameters

    • v: number

    Returns void

separatorHorizontalPaddingTop

  • get separatorHorizontalPaddingTop(): number

  • Gets or sets the top padding for separators in the horizontal orientation.

    Returns number

  • set separatorHorizontalPaddingTop(v: number): void

  • Parameters

    • v: number

    Returns void

separatorVerticalPaddingBottom

  • get separatorVerticalPaddingBottom(): number

  • Gets or sets the bottom padding for separators in the vertical orientation.

    Returns number

  • set separatorVerticalPaddingBottom(v: number): void

  • Parameters

    • v: number

    Returns void

separatorVerticalPaddingLeft

  • get separatorVerticalPaddingLeft(): number

  • Gets or sets the left padding for separators in the vertical orientation.

    Returns number

  • set separatorVerticalPaddingLeft(v: number): void

  • Parameters

    • v: number

    Returns void

separatorVerticalPaddingRight

  • get separatorVerticalPaddingRight(): number

  • Gets or sets the right padding for separators in the vertical orientation.

    Returns number

  • set separatorVerticalPaddingRight(v: number): void

  • Parameters

    • v: number

    Returns void

separatorVerticalPaddingTop

  • get separatorVerticalPaddingTop(): number

  • Gets or sets the top padding for separators in the vertical orientation.

    Returns number

  • set separatorVerticalPaddingTop(v: number): void

  • Parameters

    • v: number

    Returns void

showOnHover

  • get showOnHover(): boolean

  • Gets or sets if the tool actions should display their submenus on mouse hover.

    Returns boolean

  • set showOnHover(v: boolean): void

  • Parameters

    • v: boolean

    Returns void

showTooltipOnHover

  • get showTooltipOnHover(): boolean

  • Gets or sets if the tool action icon buttons should display their tooltips on mouse hover.

    Returns boolean

  • set showTooltipOnHover(v: boolean): void

  • Parameters

    • v: boolean

    Returns void

stopPropagation

  • get stopPropagation(): boolean

  • Prevents clicks on the tool actions from bubbling.

    Returns boolean

  • set stopPropagation(v: boolean): void

  • Parameters

    • v: boolean

    Returns void

subMenuClosing

  • Event raised when a submenu is closed on the toolbar

    Returns EventEmitter<{
        args: IgxToolbarSubMenuClosingEventArgs;
        sender: any;
    }>

subMenuOpening

  • Event raised when a submenu is opened on the toolbar.

    Returns EventEmitter<{
        args: IgxToolbarSubMenuOpeningEventArgs;
        sender: any;
    }>

submenuBackgroundColor

  • Gets or sets the background color for submenus.

    Returns string

  • Parameters

    • v: string

    Returns void

subtitleTextColor

  • get subtitleTextColor(): string

  • Gets or sets the text color for subtitles.

    Returns string

  • set subtitleTextColor(v: string): void

  • Parameters

    • v: string

    Returns void

subtitleTextStyle

  • get subtitleTextStyle(): string

  • Gets or sets the text style for subtitles.

    Returns string

  • set subtitleTextStyle(v: string): void

  • Parameters

    • v: string

    Returns void

target

  • get target(): any

  • Gets or sets a target component which the toolbar can request actions from.

    Returns any

  • set target(v: any): void

  • Parameters

    • v: any

    Returns void

textColor

  • get textColor(): string

  • Gets or sets the color to use for the text of the component.

    Returns string

  • set textColor(v: string): void

  • Parameters

    • v: string

    Returns void

toolTipBackgroundColor

  • get toolTipBackgroundColor(): string

  • Gets or sets the tooltip background color.

    Returns string

  • set toolTipBackgroundColor(v: string): void

  • Parameters

    • v: string

    Returns void

toolTipCornerRadius

  • get toolTipCornerRadius(): number

  • Gets or sets the tooltip corner radius.

    Returns number

  • set toolTipCornerRadius(v: number): void

  • Parameters

    • v: number

    Returns void

toolTipElevation

  • get toolTipElevation(): number

  • Gets or sets the shadow elevation for the tooltip.

    Returns number

  • set toolTipElevation(v: number): void

  • Parameters

    • v: number

    Returns void

toolTipTextColor

  • get toolTipTextColor(): string

  • Gets or sets the tooltip text color.

    Returns string

  • set toolTipTextColor(v: string): void

  • Parameters

    • v: string

    Returns void

uncheckedBackgroundColor

  • get uncheckedBackgroundColor(): string

  • Gets or sets the background color of the radio when in the unchecked state.

    Returns string

  • set uncheckedBackgroundColor(v: string): void

  • Parameters

    • v: string

    Returns void

uncheckedBorderColor

  • get uncheckedBorderColor(): string

  • Gets or sets the border color of the radio when in the unchecked state.

    Returns string

  • set uncheckedBorderColor(v: string): void

  • Parameters

    • v: string

    Returns void

width

  • get width(): string

  • Returns string

  • set width(value: string): void

  • Parameters

    • value: string

    Returns void

Methods

closeSubmenus

  • Forces any open sub menus to close.

    Returns void

exportSerializedVisualData

  • Returns a serialized copy of the exported visual model

    Returns string

exportVisualData

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

    Returns any

findByName

  • Parameters

    • name: string

    Returns any

flushRefresh

  • Returns void

getBoolContextItem

  • Parameters

    • key: string

    Returns boolean

getBrushCollectionContextItem

  • Parameters

    • key: string

    Returns string[]

getBrushContextItem

  • Parameters

    • key: string

    Returns string

getColorContextItem

  • Parameters

    • key: string

    Returns string

getDataContextItem

  • Parameters

    • key: string

    Returns any

getDataURLFromCache

  • Parameters

    • iconCollection: string
    • iconName: string

    Returns string

getDesiredSize

  • Get the desired size the toolbar wants to be.

    Returns IgSize

getDoubleContextItem

  • Parameters

    • key: string

    Returns number

getExternalDataContextItem

  • Parameters

    • key: string

    Returns any

getExternalDoubleContextItem

  • Parameters

    • key: string

    Returns number

getExternalIntContextItem

  • Parameters

    • key: string

    Returns number

getIconFromCache

  • Parameters

    • iconCollection: string
    • iconName: string

    Returns string

getIconSource

  • Parameters

    • iconCollection: string
    • iconName: string

    Returns any

getIntContextItem

  • Parameters

    • key: string

    Returns number

getMultiPathSVGFromCache

  • Parameters

    • iconCollection: string
    • iconName: string

    Returns string[]

getStringContextItem

  • Parameters

    • key: string

    Returns string

ngAfterContentInit

  • Returns void

ngAfterViewInit

  • Returns void

ngOnDestroy

  • Returns void

onCommandStateChanged

  • Parameters

    Returns void

registerIconFromDataURL

  • Parameters

    • iconCollection: string
    • iconName: string
    • dataURL: string

    Returns void

registerIconFromText

  • Parameters

    • iconCollection: string
    • iconName: string
    • iconText: string

    Returns void

registerIconSource

  • Parameters

    • iconCollection: string
    • iconName: string
    • source: any

    Returns void

registerMultiPathSVG

  • Parameters

    • iconCollection: string
    • iconName: string
    • multiPathSVG: string[]

    Returns void

setBoolContextItem

  • Parameters

    • key: string
    • value: boolean

    Returns void

setBrushCollectionContextItem

  • Parameters

    • key: string
    • value: string[]

    Returns void

setBrushContextItem

  • Parameters

    • key: string
    • value: string

    Returns void

setColorContextItem

  • Parameters

    • key: string
    • value: string

    Returns void

setDataContextItem

  • Parameters

    • key: string
    • value: any

    Returns void

setDoubleContextItem

  • Parameters

    • key: string
    • value: number

    Returns void

setExternalDataContextItem

  • Parameters

    • key: string
    • value: any

    Returns void

setExternalDoubleContextItem

  • Parameters

    • key: string
    • value: any

    Returns void

setExternalIntContextItem

  • Parameters

    • key: string
    • value: any

    Returns void

setIntContextItem

  • Parameters

    • key: string
    • value: number

    Returns void

setStringContextItem

  • Parameters

    • key: string
    • value: string

    Returns void

updateStyle

  • Returns void