@carbon/charts
    Preparing search index...

    Class Grid

    Hierarchy (View Summary)

    Index

    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

    Properties

    backdrop: any
    configs: any = {}
    id: string = ''
    model: ChartModel
    parent: Selection<SVGGraphicsElement | HTMLDivElement, any, HTMLElement, any> = undefined
    renderType: RenderTypes = RenderTypes.SVG
    services: Services
    type: string = 'grid'

    Methods

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

      Parameters

      • position: any

        mouse positon

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

    • Parameters

      • configs: { ariaLabel?: string; isPresentational?: boolean; withinChartClip?: boolean } = ...

      Returns Selection<any, any, Element, any>

    • 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

    • 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

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods