Class Toolbar

Hierarchy (view full)

Component
- Toolbar

Constructors

constructor

new Toolbar(model, services, configs?): Toolbar
Parameters
- model: ChartModel
- services: Services
- Optionalconfigs: any
Returns Toolbar
Inherited from Component.constructor
- Defined in packages/core/src/components/component.ts:25

Properties

`Protected`configs

configs: any = {}

id

id: string = ''

`Protected`model

model: ChartModel

overflowButton

overflowButton: any

overflowMenu

overflowMenu: any

`Protected`parent

parent: Selection<SVGGraphicsElement | HTMLDivElement, any, HTMLElement, any> = undefined

renderType

renderType: RenderTypes = RenderTypes.HTML

`Protected`services

services: Services

type

type: string = 'toolbar'

`Static`buttonID

buttonID: number = 0

Methods

destroy

destroy(): void
Returns void
Inherited from Component.destroy
- Defined in packages/core/src/components/component.ts:58

focusOnNextEnabledMenuItem

focusOnNextEnabledMenuItem(currentItemIndex): void
Parameters
- currentItemIndex: number
Returns void
- Defined in packages/core/src/components/axes/toolbar.ts:284

focusOnNextEnabledToolbarItem

focusOnNextEnabledToolbarItem(currentItemIndex): void
Parameters
- currentItemIndex: number
Returns void
- Defined in packages/core/src/components/axes/toolbar.ts:233

focusOnPreviousEnabledMenuItem

focusOnPreviousEnabledMenuItem(currentItemIndex): void
Parameters
- currentItemIndex: number
Returns void
- Defined in packages/core/src/components/axes/toolbar.ts:259

focusOnPreviousEnabledToolbarItem

focusOnPreviousEnabledToolbarItem(currentItemIndex): void
Parameters
- currentItemIndex: number
Returns void
- Defined in packages/core/src/components/axes/toolbar.ts:208

getComponentContainer

getComponentContainer(configs?): Selection<any, any, Element, any>
Parameters
- configs: {
      ariaLabel?: string;
      isPresentational?: boolean;
      withinChartClip?: boolean;
  } = ...
  - OptionalariaLabel?: string
  - OptionalisPresentational?: boolean
  - OptionalwithinChartClip?: boolean
Returns Selection<any, any, Element, any>
Inherited from Component.getComponentContainer
- Defined in packages/core/src/components/component.ts:94

getControlConfigByType

getControlConfigByType(controlType): any
Parameters
- controlType: ToolbarControlTypes
Returns any
- Defined in packages/core/src/components/axes/toolbar.ts:492

getControlConfigs

getControlConfigs(): {
    buttonList: any[];
    overflowMenuItemList?: undefined;
} | {
    buttonList: any[];
    overflowMenuItemList: any[];
}
Returns {
    buttonList: any[];
    overflowMenuItemList?: undefined;
} | {
    buttonList: any[];
    overflowMenuItemList: any[];
}
- Defined in packages/core/src/components/axes/toolbar.ts:383

getControlIconByType

getControlIconByType(controlType):
    | "<polygon points=\"19 13 15 13 15 9 13 9 13 13 9 13 9 15 13 15 13 19 15 19 15 15 19 15 19 13\"/>\n\t\t\t\t\t\t<path d=\"M22.45,21A10.87,10.87,0,0,0,25,14,11,11,0,1,0,14,25a10.87,10.87,0,0,0,7-2.55L28.59,30,30,28.59ZM14,23a9,9,0,1,1,9-9A9,9,0,0,1,14,23Z\"/>"
    | "<rect x=\"9\" y=\"13\" width=\"10\" height=\"2\"/>\n\t\t\t\t\t\t<path d=\"M22.45,21A10.87,10.87,0,0,0,25,14,11,11,0,1,0,14,25a10.87,10.87,0,0,0,7-2.55L28.59,30,30,28.59ZM14,23a9,9,0,1,1,9-9A9,9,0,0,1,14,23Z\"/>"
    | "<path d=\"M22.4478,21A10.855,10.855,0,0,0,25,14,10.99,10.99,0,0,0,6,6.4658V2H4v8h8V8H7.332a8.9768,8.9768,0,1,1-2.1,8H3.1912A11.0118,11.0118,0,0,0,14,25a10.855,10.855,0,0,0,7-2.5522L28.5859,30,30,28.5859Z\"/>"
    | "<polygon points=\"21 2 21 4 26.59 4 17 13.58 18.41 15 28 5.41 28 11 30 11 30 2 21 2\"/><polygon points=\"15 18.42 13.59 17 4 26.59 4 21 2 21 2 30 11 30 11 28 5.41 28 15 18.42\"/>"
    | "<polygon points=\"4 18 4 20 10.586 20 2 28.582 3.414 30 12 21.414 12 28 14 28 14 18 4 18\"/><polygon points=\"30 3.416 28.592 2 20 10.586 20 4 18 4 18 14 28 14 28 12 21.414 12 30 3.416\"/>"
    | "<rect x=\"4\" y=\"6\" width=\"18\" height=\"2\"/><rect x=\"4\" y=\"12\" width=\"18\" height=\"2\"/><rect x=\"4\" y=\"18\" width=\"18\" height=\"2\"/><rect x=\"4\" y=\"24\" width=\"18\" height=\"2\"/><rect x=\"26\" y=\"6\" width=\"2\" height=\"2\"/><rect x=\"26\" y=\"12\" width=\"2\" height=\"2\"/><rect x=\"26\" y=\"18\" width=\"2\" height=\"2\"/><rect x=\"26\" y=\"24\" width=\"2\" height=\"2\"/>"
Parameters
- controlType: ToolbarControlTypes
Returns
    | "<polygon points=\"19 13 15 13 15 9 13 9 13 13 9 13 9 15 13 15 13 19 15 19 15 15 19 15 19 13\"/>\n\t\t\t\t\t\t<path d=\"M22.45,21A10.87,10.87,0,0,0,25,14,11,11,0,1,0,14,25a10.87,10.87,0,0,0,7-2.55L28.59,30,30,28.59ZM14,23a9,9,0,1,1,9-9A9,9,0,0,1,14,23Z\"/>"
    | "<rect x=\"9\" y=\"13\" width=\"10\" height=\"2\"/>\n\t\t\t\t\t\t<path d=\"M22.45,21A10.87,10.87,0,0,0,25,14,11,11,0,1,0,14,25a10.87,10.87,0,0,0,7-2.55L28.59,30,30,28.59ZM14,23a9,9,0,1,1,9-9A9,9,0,0,1,14,23Z\"/>"
    | "<path d=\"M22.4478,21A10.855,10.855,0,0,0,25,14,10.99,10.99,0,0,0,6,6.4658V2H4v8h8V8H7.332a8.9768,8.9768,0,1,1-2.1,8H3.1912A11.0118,11.0118,0,0,0,14,25a10.855,10.855,0,0,0,7-2.5522L28.5859,30,30,28.5859Z\"/>"
    | "<polygon points=\"21 2 21 4 26.59 4 17 13.58 18.41 15 28 5.41 28 11 30 11 30 2 21 2\"/><polygon points=\"15 18.42 13.59 17 4 26.59 4 21 2 21 2 30 11 30 11 28 5.41 28 15 18.42\"/>"
    | "<polygon points=\"4 18 4 20 10.586 20 2 28.582 3.414 30 12 21.414 12 28 14 28 14 18 4 18\"/><polygon points=\"30 3.416 28.592 2 20 10.586 20 4 18 4 18 14 28 14 28 12 21.414 12 30 3.416\"/>"
    | "<rect x=\"4\" y=\"6\" width=\"18\" height=\"2\"/><rect x=\"4\" y=\"12\" width=\"18\" height=\"2\"/><rect x=\"4\" y=\"18\" width=\"18\" height=\"2\"/><rect x=\"4\" y=\"24\" width=\"18\" height=\"2\"/><rect x=\"26\" y=\"6\" width=\"2\" height=\"2\"/><rect x=\"26\" y=\"12\" width=\"2\" height=\"2\"/><rect x=\"26\" y=\"18\" width=\"2\" height=\"2\"/><rect x=\"26\" y=\"24\" width=\"2\" height=\"2\"/>"
- Defined in packages/core/src/components/axes/toolbar.ts:635

getOptions

getOptions(): any
graphs used in combo charts share a model with global options but can receive their own local options. this function retrieves the global options and merges it with any options passed into this component's config.options object.

Returns any
Inherited from Component.getOptions
- Defined in packages/core/src/components/component.ts:152

getOverflowButtonConfig

getOverflowButtonConfig(): {
    clickFunction: ((event: any) => void);
    iconSVG: {
        content: string;
    };
    id: string;
    shouldBeDisabled: (() => boolean);
    title: any;
}
Returns {
    clickFunction: ((event: any) => void);
    iconSVG: {
        content: string;
    };
    id: string;
    shouldBeDisabled: (() => boolean);
    title: any;
}
- clickFunction: ((event: any) => void)
  - - (event): void
    - Parameters
      event: any
      Returns void
- iconSVG: {
  content: string;
  }
  - content: string
- id: string
- shouldBeDisabled: (() => boolean)
  - - (): boolean
    - Returns boolean
- title: any
- Defined in packages/core/src/components/axes/toolbar.ts:472

getOverflowMenuItems

getOverflowMenuItems(): any[]
Returns any[]
- Defined in packages/core/src/components/axes/toolbar.ts:462

getParent

getParent(): Selection<SVGGraphicsElement | HTMLDivElement, any, HTMLElement, any>
Returns Selection<SVGGraphicsElement | HTMLDivElement, any, HTMLElement, any>
Inherited from Component.getParent
- Defined in packages/core/src/components/component.ts:90

getToolbarButtonItems

getToolbarButtonItems(): any[]
Returns any[]
- Defined in packages/core/src/components/axes/toolbar.ts:450

init

init(): void
Returns void
Overrides Component.init
- Defined in packages/core/src/components/axes/toolbar.ts:18

isOverflowMenuOpen

isOverflowMenuOpen(): any
Returns any
- Defined in packages/core/src/components/axes/toolbar.ts:181

render

render(animate?): void
Parameters
- animate: boolean = true
Returns void
Overrides Component.render
- Defined in packages/core/src/components/axes/toolbar.ts:39

renderOverflowMenu

renderOverflowMenu(): void
Returns void
- Defined in packages/core/src/components/axes/toolbar.ts:150

setModel

setModel(newObj): void
Parameters
- newObj: any
Returns void
Inherited from Component.setModel
- Defined in packages/core/src/components/component.ts:63

setParent

setParent(parent): void
Parameters
- parent: any
Returns void
Inherited from Component.setParent
- Defined in packages/core/src/components/component.ts:72

setServices

setServices(newObj): void
Parameters
- newObj: any
Returns void
Inherited from Component.setServices
- Defined in packages/core/src/components/component.ts:68

toggleOverflowMenu

toggleOverflowMenu(event): void
Parameters
- event: any
Returns void
- Defined in packages/core/src/components/axes/toolbar.ts:310

triggerFunctionAndEvent

triggerFunctionAndEvent(control, event, element?): void
Parameters
- control: any
- event: CustomEvent<any>
- Optionalelement: any
Returns void
- Defined in packages/core/src/components/axes/toolbar.ts:364

updateOverflowMenu

updateOverflowMenu(show): void
Parameters
- show: boolean
Returns void
- Defined in packages/core/src/components/axes/toolbar.ts:186

Class Toolbar

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Toolbar

Properties

Protectedconfigs

id

Protectedmodel

overflowButton

overflowMenu

Protectedparent

renderType

Protectedservices

type

StaticbuttonID

Methods

destroy

Returns void

focusOnNextEnabledMenuItem

Parameters

Returns void

focusOnNextEnabledToolbarItem

Parameters

Returns void

focusOnPreviousEnabledMenuItem

Parameters

Returns void

focusOnPreviousEnabledToolbarItem

Parameters

Returns void

getComponentContainer

Parameters

OptionalariaLabel?: string

OptionalisPresentational?: boolean

OptionalwithinChartClip?: boolean

Returns Selection<any, any, Element, any>

getControlConfigByType

Parameters

Returns any

getControlConfigs

Returns { buttonList: any[]; overflowMenuItemList?: undefined; } | { buttonList: any[]; overflowMenuItemList: any[]; }

getControlIconByType

Parameters

getOptions

Returns any

getOverflowButtonConfig

Returns { clickFunction: ((event: any) => void); iconSVG: { content: string; }; id: string; shouldBeDisabled: (() => boolean); title: any; }

clickFunction: ((event: any) => void)

Parameters

Returns void

iconSVG: { content: string; }

content: string

id: string

shouldBeDisabled: (() => boolean)

Returns boolean

title: any

getOverflowMenuItems

Returns any[]

getParent

Returns Selection<SVGGraphicsElement | HTMLDivElement, any, HTMLElement, any>

getToolbarButtonItems

Returns any[]

init

Returns void

isOverflowMenuOpen

Returns any

render

Parameters

Returns void

renderOverflowMenu

Returns void

setModel

Parameters

Returns void

`Protected`configs

`Protected`model

`Protected`parent

`Protected`services

`Static`buttonID

`Optional`ariaLabel?: string

`Optional`isPresentational?: boolean

`Optional`withinChartClip?: boolean

Returns {
buttonList: any[];
overflowMenuItemList?: undefined;
} | {
buttonList: any[];
overflowMenuItemList: any[];
}

Returns {
clickFunction: ((event: any) => void);
iconSVG: {
content: string;
};
id: string;
shouldBeDisabled: (() => boolean);
title: any;
}

iconSVG: {
content: string;
}