@carbon/charts
    Preparing search index...

    Class ColorScaleLegend

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    configs id model parent renderType services type

    Methods

    addAdditionalItem addEventListeners destroy drawLinear drawQuantize getComponentContainer getOptions getParent handleAxisCompleteEvent init render setModel setParent setServices sortDataGroups truncateLegendText

    Constructors

    Properties

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

    Methods

    • Renders quantized legend

      Parameters

      • colorPairing: any
      • colorScheme: any
      • customColorsEnabled: any
      • legendGroupElement: any
      • barWidth: any

      Returns number

      number (range start)

    • Parameters

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

      Returns Selection<any, any, Element, 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

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods