Legend

7 Jun 202324 minutes to read

The legend contains the list of chart series and Trendlines that appear in a chart.

Legend Visibility

By default, the legend is enabled in the chart. You can enable or disable it by using the visible option of the legend.

  • JAVASCRIPT
  • $("#container").ejChart({
             // ...
             legend: {
                //Visible chart legend
                visible: true
            },
            //...
         });

    Visible

    Click here to view the online demo sample for legend position.

    Legend title

    To add the title to the legend, you have to specify the text option.

  • JAVASCRIPT
  • $("#container").ejChart({
                // ...             
                  legend: {
                    //...
                    title: {
                       //Add title to the chart legend
    	               text: "Countries",
    				
    		         }  },
    
                // ...             
            });

    Title

    Position and Align the Legend

    By using the position option, you can position the legend at left, right, top or bottom of the chart. The legend is positioned at the bottom of the chart, by default.

  • JAVASCRIPT
  • $("#container").ejChart({
                // ...             
                legend: {
                    // ...  
                    //Place the legend at top of the chart
                    position: 'top',
    
                }
                // ...             
            });

    Position

    Legend Alignment

    You can align the legend to the center, far or near based on its position by using the alignment option.

  • JAVASCRIPT
  • $("#container").ejChart({
                // ...             
                legend: {
                    //...
                    //The below two settings will place the legend at the top-right corner of the chart.
                    alignment: 'far',
                    position: 'top', 
                }
                // ...             
            });

    Alignment

    Arrange legend items in the rows and columns

    You can arrange the legend items horizontally and vertically by using the rowCount and columnCount options of the legend.

    • When only the rowCount is specified, the legend items are arranged according to the rowCount and number of columns may vary based on the number of legend items.

    • When only the columnCount is specified, the legend items are arranged according to the columnCount and number of rows may vary based on the number of legend items.

    • When both the options are specified, then the one which has higher value is given preference. For example, when the rowCount is 4 and columnCount is 3, legend items are arranged in 4 rows.

    • When both the options are specified and have the same value, the preference is given to the columnCount when it is positioned at the top/bottom position. The preference is given to the rowCount when it is positioned at the left/right position.

  • JAVASCRIPT
  • $("#container").ejChart({
                // ...             
                legend: {
                    //Arrange legend items in 4 rows and approximately 4 columns. Column couldn’t may vary based on number of items. 
                    rowCount: 4,
                    columnCount: 4 
                }
                // ...             
            });

    RowColumn

    Customization

    Legend shape

    To change the legend icon shape, you have to specify the shape in the shape property of the legend. When you want the legend icon to display the prototype of the series, you have to set the seriesType as shape.

  • JAVASCRIPT
  • $("#container").ejChart({
                // ...             
                legend: {
                    //...
                    //Change legend shape
                     shape: 'seriesType',
                }
                // ...             
            });

    Shape

    Legend items size and border

    You can change the size of the legend items by using the width and height options. To change the legend item border, use border option of the legend itemStyle.

  • JAVASCRIPT
  • $("#container").ejChart({
                // ...             
                legend: {
                    //...
                    //Change legend items border, height and width
                    itemStyle: {width: 13, height: 13, border: { color: "#FF0000", width: 1 } },
                }
                // ...             
            });

    ItemStyle

    Legend size

    By default, legend takes 20% of the height horizontally when it was placed on the top or bottom position and 20% of the width vertically while placing on the left or right position of the chart. You can change this default legend size by using the size option of the legend.

  • JAVASCRIPT
  • $("#container").ejChart({   
                // ...
                legend: { 
                     //...
                     //Change legend size
                     size:{width: '550', height: '100'}
                }
                // ...             
            });

    Size

    Legend Item Padding

    You can control the spacing between the legend items by using the itemPadding option of the legend. The default value is 10.

  • JAVASCRIPT
  • $("#container").ejChart({
                // ...             
                legend: {
                    //...
                    //Add space between each legend item
                    itemPadding: 15,
                }
                // ...             
            });

    ItemPadding

    Legend background

    You can customize the legend background by using the background option in the legend.

  • JAVASCRIPT
  • $("#container").ejChart({
                // ...             
                legend: {
                    //...
                    //Set background image for the legend
                    background : "green url('flower.png')"} 
                }
                // ...             
            });

    Legend fill

    You can customize the legend item shape color by using the fill option in the legend.
    By using this property, it displays all legend item shapes in same color.Legend items representing invisible series is displayed in gray color.

  • JAVASCRIPT
  • $("#container").ejChart({
                // ...             
                legend: {
                    //...
                    //Set fill color  for the legend
                    fill : "green "} 
                }
                // ...             
            });

    Legend border

    You can customize the legend border by using the border option in the legend.
    The color and width of the border are customized using the color and width properties.

  • JAVASCRIPT
  • $("#container").ejChart({
                // ...             
                legend: {
                    //...
                    //Set border color and width to legend
                    border: {color: "#FFC342", width: 2},
                }
                // ...             
            });

    Border

    Legend opacity

    You can customize the legend opacity by using the opacity option in the legend.

  • JAVASCRIPT
  • $("#container").ejChart({
                // ...             
                legend: {
                    //...
                    //Set opacity for the  legend
                   opacity: 0.5,
                }
                // ...             
            });

    Scrollbar for legend

    You can enable or disable the legend scrollbar by using the enableScrollbar option of the legend. When you disable the scrollbar option, the legend does not consider the default size and chart draws in the remaining space. If you have specified the size to the legend with the scrollbar disabled, then the legends beyond this limit will get clipped. The default value of enableScrollbar option is true.

  • JAVASCRIPT
  • $("#container").ejChart({
                // ...             
                legend: {
                    //...
                    //Enable scrollbar option in for legend
                    enableScrollbar: true,
                    size:{width: '430', height: '80'},
                }
                // ...             
            });

    Scrollbar

    Legend Location

    The location property is used for customizing the position of the chart legend.
    Legend is placed in provided location only when value of position property is custom. Both the xand y locations can be customized in the location property

  • JAVASCRIPT
  • $("#container").ejChart({
                // ...             
                legend: {
                    //...
                   
                    location :{x :20 ,y:100}  
                }
                // ...             
            });

    Customize the legend text

    To customize the legend item text and title you can use the font and title options. You can change the legend title alignment by using the textAlignment option of the legend title.

  • JAVASCRIPT
  • $("#container").ejChart({
                // ...             
                legend: {
                    //...
                    //Customize the legend item text
                    font: { fontFamily: 'Segoe UI', fontStyle: 'Normal', fontWeight: 'Bold', size: '15px' },
                    title: {
                        //...
    		            textAlignment: "center",
                        //Customize the legend title text
    	                font: { fontFamily: 'Segoe UI', fontStyle: 'Italic', 
                                            fontWeight: 'Bold', size: '12px' },
    	             }            
                 },
                // ...             
            });

    LegendText

    LegendItems Text Overflow

    Trim

    You can trim the legend item text when its width exceeds the legend.textWidth, by specifying textOverflow as “trim”. The original text will be displayed on mouse hover.

  • JAVASCRIPT
  • $("#container").ejChart({
                
                // ...             
                legend: {
                   //trim the legend text
    		        textOverflow: 'trim', 
    		        textWidth: 34
    	          } 
    
                // ...             
            });

    TextOverflow

    Wrap

    By specifying textOverflow as “wrap”, you can wrap the legend text by word.

    Wrap

    WrapAndTrim

    You can wrap and trim the legend text by specifying textOverflow as “wrapAndTrim”. The original text will be displayed on mouse hover.

    WrapAndTrim

    Handle the legend item clicked

    You can get the legend item details such as index, bounds, shape and series by subscribing the legendItemClick event on the chart. When the legend item is clicked, it triggers the event and returns the legend information.

  • JAVASCRIPT
  • $("#container").ejChart({
    
                legend: {
                       //...
                  },
                  
               //Subscribe the legend item click event
                legendItemClick: "onLegendClicked",
                
                //...
            });
            
         function onLegendClicked(sender) {
            //Get legend item details on legend item click.
            var legendItem = sender.data;
          }

    Series selection on legend item click

    You can select a specific series or point while clicking on the corresponding legend item through disabling the toggleSeriesVisibility option of the legend. The default value of toggleSeriesVisibility option is true. To customize the series selection refer to the series selection.

  • JAVASCRIPT
  • $("#container").ejChart({
                // ...             
                    legend: {
                       //...
                       //Disable series collapsing on legend item clicked
                       toggleSeriesVisibility: false,
                   },
               //...
          });

    ToggleVisibility

    Collapsing legend item

    You can collapse the specific series/point legend item displaying in the chart, by setting the visibleOnLegend as “hidden” in the point or series.

  • JAVASCRIPT
  • $("#container").ejChart({
         
              //Initializing Series
              series:[{
                 points: [{ x: 'Albania', y: 60.1 },
                         //...
                         //Collapse the point's legend item in the legend collection
                         { x: 'New Zealand', y: 82.8, visibleOnLegend:'hidden' }]
                      }],
             legend: { visible: true}
         });

    VisibleOnLegend

    legend enableScrollbar

    Controls whether legend has to use scrollbar or not. When enableScrollbar appears depending upon size and position properties of legend.

  • JAVASCRIPT
  • $("#container").ejChart({
         
            legend :{ enableScrollbar : false}                    
         });

    legend font

    Options to customize the fontused for legend item text.

    legend font fontFamily

    FontFamily for legend item text.

  • JAVASCRIPT
  • $("#container").ejChart({
         
           legend :{ font :{fontFamily : "Algerian"}}                           
         });

    legend font fontStyle

    FontStyle for legend item text.

  • JAVASCRIPT
  • $("#container").ejChart({
         
          legend :{ font :{fontStyle : "italic"}}                    
                        
         });

    legend font fontWeight

    FontWeightfor legend item text.

  • JAVASCRIPT
  • $("#container").ejChart({
         
        legend :{ font :{fontWeight : "lighter"}}                    
                        
         });

    legend font size

    Font [size] (../api/ejchart#members:legend-font-size)for legend item text.

  • JAVASCRIPT
  • $("#container").ejChart({
         
       legend :{ font :{size : "14px"}}                        
                        
         });

    legend itemStyle

    Options to customize the style of legend items.

    legend itemStyle border

    Options for customizing the border of legend items.

    legend itemStyle border color

    Border colorof the legend items.

  • JAVASCRIPT
  • $("#container").ejChart({
         
        legend :{ itemStyle :{border : { color : "green' }}}                             
                        
         });

    legend itemStyle border width

    Border width of the legend items.

  • JAVASCRIPT
  • $("#container").ejChart({
         
        legend :{ itemStyle :{border :{ width : 2 }}}                                             
                        
         });

    legend title font

    Options to customize the font used for legend title

    legend title font fontFamily

    FontFamily for the text in legend title.

  • JAVASCRIPT
  • $("#container").ejChart({
         
        legend: { title: { font :{fontFamily: "Algerian" } } }                                            
                        
         });

    legend title font fontStyle

    Font style for legend title

  • JAVASCRIPT
  • $("#container").ejChart({
         
        legend: { title: { font :{fontStyle: "normal" } }                                             
                        
         });

    legend title font font weight

    Font weight for legend title.

  • JAVASCRIPT
  • $("#container").ejChart({
         
        legend: { title: { font :{fontWeight: "normal" } } }                                             
                        
         });

    legend title font font size

    Font-Size for legend title.

  • JAVASCRIPT
  • $("#container").ejChart({
         
         legend: { title: { font :{size: "14px" } } }                                               
                        
         });