Class Grid

Hierarchy (view full)

Constructors

constructor

Properties

backdrop configs id model parent renderType services type

Methods

cleanGrid destroy drawBackdrop drawXGrid drawYGrid getActiveGridline getComponentContainer getGridlineThreshold getOptions getParent init render setModel setParent setServices

Constructors

constructor

Properties

backdrop

backdrop: any

Protectedconfigs

configs: any = {}

id

id: string = ''

Protectedmodel

model: ChartModel

Protectedparent

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

renderType

renderType: RenderTypes = RenderTypes.SVG

Protectedservices

services: Services

type

type: string = 'grid'

Methods

cleanGrid

destroy

drawBackdrop

drawXGrid

drawYGrid

getActiveGridline

  • getActiveGridline(position): Selection<BaseType, unknown, SVGGraphicsElement | HTMLDivElement, any>

  • Returns the active gridlines based on the gridline threshold and mouse position.

    Parameters

    • position: any

      mouse positon

    Returns Selection<BaseType, unknown, SVGGraphicsElement | HTMLDivElement, any>

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>

getGridlineThreshold

  • getGridlineThreshold(mousePos): number

  • Returns the threshold for the gridline tooltips based on the mouse location. Calculated based on the mouse position between the two closest gridlines or edges of chart.

    Parameters

    • mousePos: any

    Returns number

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

getParent

init

render

setModel

setParent

setServices

Settings

Member Visibility

On This Page

Constructors
Properties
Methods