Class ZoomBar

Hierarchy (View Summary)

Component
- ZoomBar

Constructors

constructor

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

Properties

brush

brush: BrushBehavior<unknown> = ...

brushSelector

brushSelector: string = 'g.zoom-bar-brush'

clipId

clipId: string = ...

`Protected`configs

configs: any = {}

highlightStrokeWidth

highlightStrokeWidth: number = 1

id

id: string = ''

maxSelectionRange

maxSelectionRange: [0, 0]

MIN_SELECTION_DIFF

MIN_SELECTION_DIFF: number = 9e-10

`Protected`model

model: ChartModelCartesian

`Protected`parent

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

renderType

renderType: interfaces.RenderTypes = RenderTypes.SVG

`Protected`services

services: interfaces.Services

type

type: string = 'zoom-bar'

xScale

xScale: any

yScale

yScale: any

Methods

addBrushEventListener

addBrushEventListener(zoomDomain: any, axesLeftMargin: any, width: any): void
Parameters
- zoomDomain: any
- axesLeftMargin: any
- width: any
Returns void
- Defined in packages/core/src/components/axes/zoom-bar.ts:272

compensateDataForDefaultDomain

compensateDataForDefaultDomain(data: any, defaultDomain: any): any
Parameters
- data: any
- defaultDomain: any
Returns any
- Defined in packages/core/src/components/axes/zoom-bar.ts:503

destroy

destroy(): void
Returns void
Overrides Component.destroy
- Defined in packages/core/src/components/axes/zoom-bar.ts:573

getComponentContainer

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

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

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

handleBrushedEvent

handleBrushedEvent(
    event: any,
    zoomDomain: any,
    scale: any,
    selection: any,
): void
Parameters
- event: any
- zoomDomain: any
- scale: any
- selection: any
Returns void
- Defined in packages/core/src/components/axes/zoom-bar.ts:302

init

init(): void
Returns void
Overrides Component.init
- Defined in packages/core/src/components/axes/zoom-bar.ts:37

render

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

renderSkeleton

renderSkeleton(container: any, startX: number, endX: number): void
Parameters
- container: any
- startX: number
- endX: number
Returns void
- Defined in packages/core/src/components/axes/zoom-bar.ts:557

renderZoomBarArea

renderZoomBarArea(
    container: any,
    querySelector: any,
    data: any,
    clipId: any,
): void
Parameters
- container: any
- querySelector: any
- data: any
- clipId: any
Returns void
- Defined in packages/core/src/components/axes/zoom-bar.ts:452

renderZoomBarBaseline

renderZoomBarBaseline(
    container: HTMLElement,
    startX: number,
    endX: number,
    skeletonClass?: boolean,
): void
Parameters
- container: HTMLElement
- startX: number
- endX: number
- skeletonClass: boolean = false
Returns void
- Defined in packages/core/src/components/axes/zoom-bar.ts:529

setModel

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

setParent

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

setServices

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

updateBrushHandle

updateBrushHandle(svg: any, selection: any): void
Parameters
- svg: any
- selection: any
Returns void
- Defined in packages/core/src/components/axes/zoom-bar.ts:352

updateClipPath

updateClipPath(
    svg: any,
    clipId: string,
    x: string | number,
    y: string | number,
    width: string | number,
    height: string | number,
): void
Parameters
- svg: any
- clipId: string
- x: string | number
- y: string | number
- width: string | number
- height: string | number
Returns void
- Defined in packages/core/src/components/axes/zoom-bar.ts:486

updateSliderSelectedArea

updateSliderSelectedArea(selection: any): void
Parameters
- selection: any
Returns void
- Defined in packages/core/src/components/axes/zoom-bar.ts:435