IgxToolbarComponent

Constructors

new IgxToolbarComponent(renderer: Renderer2, _elRef: ViewContainerRef, ngZone: NgZone, injector: Injector, changeDetector: ChangeDetectorRef): IgxToolbarComponent

Returns IgxToolbarComponent

Properties

_childTemplateRef

_childTemplateRef: TemplateRef<any>

_dynamicContent

_dynamicContent: ViewContainerRef

_mainDiv

_mainDiv: Element

_mainDivRef

_mainDivRef: ElementRef

combinedActions

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.

combinedActions: IgxToolActionComponent[]

contentActions

contentActions: QueryList<IgxToolActionComponent>

ngAcceptInputType_actualActions

ngAcceptInputType_actualActions: string | IgxToolActionCollection

ngAcceptInputType_autoGeneratedActions

ngAcceptInputType_autoGeneratedActions: string | IgxToolActionCollection

ngAcceptInputType_baseTheme

ngAcceptInputType_baseTheme: any

ngAcceptInputType_density

ngAcceptInputType_density: any

ngAcceptInputType_dropdownClickBuffer

ngAcceptInputType_dropdownClickBuffer: string | number

ngAcceptInputType_dropdownDelay

ngAcceptInputType_dropdownDelay: string | number

ngAcceptInputType_highlightRadius

ngAcceptInputType_highlightRadius: string | number

ngAcceptInputType_highlightWidth

ngAcceptInputType_highlightWidth: string | number

ngAcceptInputType_orientation

ngAcceptInputType_orientation: string | ToolbarOrientation

ngAcceptInputType_rowHeight

ngAcceptInputType_rowHeight: string | number

ngAcceptInputType_scrollbarStyle

ngAcceptInputType_scrollbarStyle: any

ngAcceptInputType_separatorHorizontalPaddingBottom

ngAcceptInputType_separatorHorizontalPaddingBottom: string | number

ngAcceptInputType_separatorHorizontalPaddingLeft

ngAcceptInputType_separatorHorizontalPaddingLeft: string | number

ngAcceptInputType_separatorHorizontalPaddingRight

ngAcceptInputType_separatorHorizontalPaddingRight: string | number

ngAcceptInputType_separatorHorizontalPaddingTop

ngAcceptInputType_separatorHorizontalPaddingTop: string | number

ngAcceptInputType_separatorVerticalPaddingBottom

ngAcceptInputType_separatorVerticalPaddingBottom: string | number

ngAcceptInputType_separatorVerticalPaddingLeft

ngAcceptInputType_separatorVerticalPaddingLeft: string | number

ngAcceptInputType_separatorVerticalPaddingRight

ngAcceptInputType_separatorVerticalPaddingRight: string | number

ngAcceptInputType_separatorVerticalPaddingTop

ngAcceptInputType_separatorVerticalPaddingTop: string | number

ngAcceptInputType_showOnHover

ngAcceptInputType_showOnHover: string | boolean

ngAcceptInputType_showTooltipOnHover

ngAcceptInputType_showTooltipOnHover: string | boolean

ngAcceptInputType_stopPropagation

ngAcceptInputType_stopPropagation: string | boolean

ngAcceptInputType_subPanelRowHeight

ngAcceptInputType_subPanelRowHeight: string | number

ngAcceptInputType_toolTipCornerRadius

ngAcceptInputType_toolTipCornerRadius: string | number

ngAcceptInputType_toolTipElevation

ngAcceptInputType_toolTipElevation: string | number

ɵcmp

ɵcmp: ɵɵComponentDeclaration<IgxToolbarComponent, "igx-toolbar", never, object, object, ["contentActions"], never, true, never>

ɵfac

ɵfac: ɵɵFactoryDeclaration<IgxToolbarComponent, never>

Accessors

accentColor

get accentColor(): string

Returns string

set accentColor(v: string): void

Parameters

v: string

Returns void

actions

A collection or manually added axes for the chart.

get actions(): IgxToolActionCollection

Returns IgxToolActionCollection

actualActions

Gets or sets the data or data source instance to which to bind the grid.

get actualActions(): IgxToolActionCollection

Returns IgxToolActionCollection

set actualActions(v: IgxToolActionCollection): void

Parameters

v: IgxToolActionCollection

Returns void

autoGeneratedActions

Gets or sets the data or data source instance to which to bind the grid.

get autoGeneratedActions(): IgxToolActionCollection

Returns IgxToolActionCollection

set autoGeneratedActions(v: IgxToolActionCollection): void

Parameters

v: IgxToolActionCollection

Returns void

backgroundColor

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

get backgroundColor(): string

Returns string

set backgroundColor(v: string): void

Parameters

v: string

Returns void

baseTheme

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

get baseTheme(): BaseControlTheme

Returns BaseControlTheme

set baseTheme(v: BaseControlTheme): void

Parameters

v: BaseControlTheme

Returns void

cellTextStyle

Gets or sets the text style.

get cellTextStyle(): string

Returns string

set cellTextStyle(v: string): void

Parameters

v: string

Returns void

checkboxListScrollbarActiveBackground

Gets or sets the scrollbar thumb active (dragging) background color for checkbox lists hosted in this toolbar's sub-menus.

get checkboxListScrollbarActiveBackground(): string

Returns string

set checkboxListScrollbarActiveBackground(v: string): void

Parameters

v: string

Returns void

checkboxListScrollbarBackground

Gets or sets the scrollbar background color for checkbox lists hosted in this toolbar's sub-menus.

get checkboxListScrollbarBackground(): string

Returns string

set checkboxListScrollbarBackground(v: string): void

Parameters

v: string

Returns void

checkboxListScrollbarHoverBackground

Gets or sets the scrollbar thumb hover background color for checkbox lists hosted in this toolbar's sub-menus.

get checkboxListScrollbarHoverBackground(): string

Returns string

set checkboxListScrollbarHoverBackground(v: string): void

Parameters

v: string

Returns void

checkedBackgroundColor

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

get checkedBackgroundColor(): string

Returns string

set checkedBackgroundColor(v: string): void

Parameters

v: string

Returns void

checkedBorderColor

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

get checkedBorderColor(): string

Returns string

set checkedBorderColor(v: string): void

Parameters

v: string

Returns void

density

Gets or sets the display density to use for the toolbar.

get density(): ControlDisplayDensity

Returns ControlDisplayDensity

set density(v: ControlDisplayDensity): void

Parameters

v: ControlDisplayDensity

Returns void

disabledTextColor

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

get disabledTextColor(): string

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.

get dropdownClickBuffer(): number

Returns number

set dropdownClickBuffer(v: number): void

Parameters

v: number

Returns void

dropdownDelay

Gets or sets the dropdown delay time in milliseconds.

get dropdownDelay(): number

Returns number

set dropdownDelay(v: number): void

Parameters

v: number

Returns void

groupHeaderBackgroundColor

Gets or sets the group header background color.

get groupHeaderBackgroundColor(): string

Returns string

set groupHeaderBackgroundColor(v: string): void

Parameters

v: string

Returns void

groupHeaderSubtitleTextColor

Gets or sets the text color for group header subtitles.

get groupHeaderSubtitleTextColor(): string

Returns string

set groupHeaderSubtitleTextColor(v: string): void

Parameters

v: string

Returns void

groupHeaderTextColor

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

get groupHeaderTextColor(): string

Returns string

set groupHeaderTextColor(v: string): void

Parameters

v: string

Returns void

groupHeaderTextStyle

Gets or sets the text style.

get groupHeaderTextStyle(): string

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

Gets or sets the hover background color.

get hoverBackgroundColor(): string

Returns string

set hoverBackgroundColor(v: string): void

Parameters

v: string

Returns void

i

get i(): Toolbar

Returns Toolbar

iconFill

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

get iconFill(): string

Returns string

set iconFill(v: string): void

Parameters

v: string

Returns void

iconStroke

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

get iconStroke(): string

Returns string

set iconStroke(v: string): void

Parameters

v: string

Returns void

menuArrowStroke

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

get menuArrowStroke(): string

Returns string

set menuArrowStroke(v: string): void

Parameters

v: string

Returns void

onCommand

Event raised when a command is triggered in the toolbar.

get onCommand(): EventEmitter<object>

Returns EventEmitter<object>

orientation

Gets or sets the orientation of the toolbar.

get orientation(): ToolbarOrientation

Returns ToolbarOrientation

set orientation(v: ToolbarOrientation): void

Parameters

v: ToolbarOrientation

Returns void

rowHeight

Gets or sets the row height that should be used.

get rowHeight(): number

Returns number

set rowHeight(v: number): void

Parameters

v: number

Returns void

scrollbarStyle

Gets or sets the style of scrollbar.

get scrollbarStyle(): ScrollbarStyle

Returns ScrollbarStyle

set scrollbarStyle(v: ScrollbarStyle): void

Parameters

v: ScrollbarStyle

Returns void

separatorBackgroundColor

Gets or sets the separator background color.

get separatorBackgroundColor(): string

Returns string

set separatorBackgroundColor(v: string): void

Parameters

v: string

Returns void

separatorHorizontalPaddingBottom

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

get separatorHorizontalPaddingBottom(): number

Returns number

set separatorHorizontalPaddingBottom(v: number): void

Parameters

v: number

Returns void

separatorHorizontalPaddingLeft

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

get separatorHorizontalPaddingLeft(): number

Returns number

set separatorHorizontalPaddingLeft(v: number): void

Parameters

v: number

Returns void

separatorHorizontalPaddingRight

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

get separatorHorizontalPaddingRight(): number

Returns number

set separatorHorizontalPaddingRight(v: number): void

Parameters

v: number

Returns void

separatorHorizontalPaddingTop

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

get separatorHorizontalPaddingTop(): number

Returns number

set separatorHorizontalPaddingTop(v: number): void

Parameters

v: number

Returns void

separatorVerticalPaddingBottom

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

get separatorVerticalPaddingBottom(): number

Returns number

set separatorVerticalPaddingBottom(v: number): void

Parameters

v: number

Returns void

separatorVerticalPaddingLeft

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

get separatorVerticalPaddingLeft(): number

Returns number

set separatorVerticalPaddingLeft(v: number): void

Parameters

v: number

Returns void

separatorVerticalPaddingRight

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

get separatorVerticalPaddingRight(): number

Returns number

set separatorVerticalPaddingRight(v: number): void

Parameters

v: number

Returns void

separatorVerticalPaddingTop

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

get separatorVerticalPaddingTop(): number

Returns number

set separatorVerticalPaddingTop(v: number): void

Parameters

v: number

Returns void

showOnHover

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

get showOnHover(): boolean

Returns boolean

set showOnHover(v: boolean): void

Parameters

v: boolean

Returns void

showTooltipOnHover

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

get showTooltipOnHover(): boolean

Returns boolean

set showTooltipOnHover(v: boolean): void

Parameters

v: boolean

Returns void

stopPropagation

Prevents clicks on the tool actions from bubbling.

get stopPropagation(): boolean

Returns boolean

set stopPropagation(v: boolean): void

Parameters

v: boolean

Returns void

submenuBackgroundColor

Gets or sets the background color for submenus.

get submenuBackgroundColor(): string

Returns string

set submenuBackgroundColor(v: string): void

Parameters

v: string

Returns void

subMenuClosing

Event raised when a submenu is closed on the toolbar

get subMenuClosing(): EventEmitter<object>

Returns EventEmitter<object>

subMenuOpening

Event raised when a submenu is opened on the toolbar.

get subMenuOpening(): EventEmitter<object>

Returns EventEmitter<object>

subPanelRowHeight

Gets or sets the height to use for the sub panel rows if different than default.

get subPanelRowHeight(): number

Returns number

set subPanelRowHeight(v: number): void

Parameters

v: number

Returns void

subtitleTextColor

Gets or sets the text color for subtitles.

get subtitleTextColor(): string

Returns string

set subtitleTextColor(v: string): void

Parameters

v: string

Returns void

subtitleTextStyle

Gets or sets the text style for subtitles.

get subtitleTextStyle(): string

Returns string

set subtitleTextStyle(v: string): void

Parameters

v: string

Returns void

target

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

get target(): any

Returns any

set target(v: any): void

Parameters

v: any

Returns void

textColor

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

get textColor(): string

Returns string

set textColor(v: string): void

Parameters

v: string

Returns void

toolTipBackgroundColor

Gets or sets the tooltip background color.

get toolTipBackgroundColor(): string

Returns string

set toolTipBackgroundColor(v: string): void

Parameters

v: string

Returns void

toolTipCornerRadius

Gets or sets the tooltip corner radius.

get toolTipCornerRadius(): number

Returns number

set toolTipCornerRadius(v: number): void

Parameters

v: number

Returns void

toolTipElevation

Gets or sets the shadow elevation for the tooltip.

get toolTipElevation(): number

Returns number

set toolTipElevation(v: number): void

Parameters

v: number

Returns void

toolTipTextColor

Gets or sets the tooltip text color.

get toolTipTextColor(): string

Returns string

set toolTipTextColor(v: string): void

Parameters

v: string

Returns void

uncheckedBackgroundColor

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

get uncheckedBackgroundColor(): string

Returns string

set uncheckedBackgroundColor(v: string): void

Parameters

v: string

Returns void

uncheckedBorderColor

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

get uncheckedBorderColor(): string

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.

closeSubmenus(): void

Returns void

exportSerializedVisualData

Returns a serialized copy of the exported visual model

exportSerializedVisualData(): string

Returns string

exportVisualData

Exports visual information about the current state of the grid.

exportVisualData(): any

Returns any

findByName

findByName(name: string): any

Parameters

name: string

Returns any

flushRefresh

flushRefresh(): void

Returns void

getBoolContextItem

getBoolContextItem(key: string): boolean

Parameters

key: string

Returns boolean

getBrushCollectionContextItem

getBrushCollectionContextItem(key: string): string[]

Parameters

key: string

Returns string[]

getBrushContextItem

getBrushContextItem(key: string): string

Parameters

key: string

Returns string

getColorContextItem

getColorContextItem(key: string): string

Parameters

key: string

Returns string

getDataContextItem

getDataContextItem(key: string): any

Parameters

key: string

Returns any

getDataURLFromCache

getDataURLFromCache(iconCollection: string, iconName: string): string

Parameters

iconCollection: string
iconName: string

Returns string

getDesiredSize

Get the desired size the toolbar wants to be.

getDesiredSize(): IgSize

Returns IgSize

getDoubleContextItem

getDoubleContextItem(key: string): number

Parameters

key: string

Returns number

getExternalDataContextItem

getExternalDataContextItem(key: string): any

Parameters

key: string

Returns any

getExternalDoubleContextItem

getExternalDoubleContextItem(key: string): number

Parameters

key: string

Returns number

getExternalIntContextItem

getExternalIntContextItem(key: string): number

Parameters

key: string

Returns number

getIconFromCache

getIconFromCache(iconCollection: string, iconName: string): string

Parameters

iconCollection: string
iconName: string

Returns string

getIconSource

getIconSource(iconCollection: string, iconName: string): any

Parameters

iconCollection: string
iconName: string

Returns any

getIntContextItem

getIntContextItem(key: string): number

Parameters

key: string

Returns number

getMultiPathSVGFromCache

getMultiPathSVGFromCache(iconCollection: string, iconName: string): string[]

Parameters

iconCollection: string
iconName: string

Returns string[]

getStringContextItem

getStringContextItem(key: string): string

Parameters

key: string

Returns string

isOpen

Is a dropdown menu or tooltip currently open.

isOpen(): boolean

Returns boolean

ngAfterContentInit

ngAfterContentInit(): void

Returns void

ngAfterViewInit

ngAfterViewInit(): void

Returns void

ngOnDestroy

ngOnDestroy(): void

Returns void

onCommandStateChanged

onCommandStateChanged(id: string, type: any, value: any): void

Parameters

id: string
type: any
value: any

Returns void

registerIconFromDataURL

registerIconFromDataURL(iconCollection: string, iconName: string, dataURL: string): void

Parameters

iconCollection: string
iconName: string
dataURL: string

Returns void

registerIconFromText

registerIconFromText(iconCollection: string, iconName: string, iconText: string): void

Parameters

iconCollection: string
iconName: string
iconText: string

Returns void

registerIconSource

registerIconSource(iconCollection: string, iconName: string, source: any): void

Parameters

iconCollection: string
iconName: string
source: any

Returns void

registerMultiPathSVG

registerMultiPathSVG(iconCollection: string, iconName: string, multiPathSVG: string[]): void

Parameters

iconCollection: string
iconName: string
multiPathSVG: string[]

Returns void

setBoolContextItem

setBoolContextItem(key: string, value: boolean): void

Parameters

key: string
value: boolean

Returns void

setBrushCollectionContextItem

setBrushCollectionContextItem(key: string, value: string[]): void

Parameters

key: string
value: string[]

Returns void

setBrushContextItem

setBrushContextItem(key: string, value: string): void

Parameters

key: string
value: string

Returns void

setColorContextItem

setColorContextItem(key: string, value: string): void

Parameters

key: string
value: string

Returns void

setDataContextItem

setDataContextItem(key: string, value: any): void

Parameters

key: string
value: any

Returns void

setDoubleContextItem

setDoubleContextItem(key: string, value: number): void

Parameters

key: string
value: number

Returns void

setExternalDataContextItem

setExternalDataContextItem(key: string, value: any): void

Parameters

key: string
value: any

Returns void

setExternalDoubleContextItem

setExternalDoubleContextItem(key: string, value: any): void

Parameters

key: string
value: any

Returns void

setExternalIntContextItem

setExternalIntContextItem(key: string, value: any): void

Parameters

key: string
value: any

Returns void

setIntContextItem

setIntContextItem(key: string, value: number): void

Parameters

key: string
value: number

Returns void

setStringContextItem

setStringContextItem(key: string, value: string): void

Parameters

key: string
value: string

Returns void

updateStyle

updateStyle(): void