2021-12-10 17:17:40 +01:00
<!DOCTYPE html>
2022-04-02 18:41:16 +02:00
<!-- Generated by pkgdown: do not edit by hand --> < html lang = "en" > < head > < meta http-equiv = "Content-Type" content = "text/html; charset=UTF-8" > < meta charset = "utf-8" > < meta http-equiv = "X-UA-Compatible" content = "IE=edge" > < meta name = "viewport" content = "width=device-width, initial-scale=1, shrink-to-fit=no" > < meta name = "description" content = "Legend properties" > < title > Legend properties — ax_legend • apexcharter< / title > < script src = "../deps/jquery-3.6.0/jquery-3.6.0.min.js" > < / script > < meta name = "viewport" content = "width=device-width, initial-scale=1, shrink-to-fit=no" > < link href = "../deps/bootstrap-5.1.0/bootstrap.min.css" rel = "stylesheet" > < script src = "../deps/bootstrap-5.1.0/bootstrap.bundle.min.js" > < / script > < link href = "../deps/_Poppins-0.4.1/font.css" rel = "stylesheet" > <!-- Font Awesome icons --> < link rel = "stylesheet" href = "https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.1/css/all.min.css" integrity = "sha256-mmgLkCYLUQbXn0B1SRqzHar6dCnv9oZFPEC1g1cwlkk=" crossorigin = "anonymous" > < link rel = "stylesheet" href = "https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.1/css/v4-shims.min.css" integrity = "sha256-wZjR52fzng1pJHwx4aV2AO3yyTOXrcDW7jBpJtTwVxw=" crossorigin = "anonymous" > <!-- bootstrap - toc --> < script src = "https://cdn.rawgit.com/afeld/bootstrap-toc/v1.0.1/dist/bootstrap-toc.min.js" > < / script > <!-- headroom.js --> < script src = "https://cdnjs.cloudflare.com/ajax/libs/headroom/0.11.0/headroom.min.js" integrity = "sha256-AsUX4SJE1+yuDu5+mAVzJbuYNPHj/WroHuZ8Ir/CkE0=" crossorigin = "anonymous" > < / script > < script src = "https://cdnjs.cloudflare.com/ajax/libs/headroom/0.11.0/jQuery.headroom.min.js" integrity = "sha256-ZX/yNShbjqsohH1k95liqY9Gd8uOiE1S4vZc+9KQ1K4=" crossorigin = "anonymous" > < / script > <!-- clipboard.js --> < script src = "https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.6/clipboard.min.js" integrity = "sha256-inc5kl9MA1hkeYUt+EC3BhlIgyp/2jDIyBLS6k3UxPI=" crossorigin = "anonymous" > < / script > <!-- search --> < script src = "https://cdnjs.cloudflare.com/ajax/libs/fuse.js/6.4.6/fuse.js" integrity = "sha512-zv6Ywkjyktsohkbp9bb45V6tEMoWhzFzXis+LrMehmJZZSys19Yxf1dopHx7WzIKxr5tK2dVcYmaCk2uqdjF4A==" crossorigin = "anonymous" > < / script > < script src = "https://cdnjs.cloudflare.com/ajax/libs/autocomplete.js/0.38.0/autocomplete.jquery.min.js" integrity = "sha512-GU9ayf+66Xx2TmpxqJpliWbT5PiGYxpaG8rfnBEk1LL8l1KGkRShhngwdXK1UgqhAzWpZHSiYPc09/NwDQIGyg==" crossorigin = "anonymous" > < / script > < script src = "https://cdnjs.cloudflare.com/ajax/libs/mark.js/8.11.1/mark.min.js" integrity = "sha512-5CYOlHXGh6QpOFA/TeTylKLWfB3ftPsde7AnmhuitiTX4K5SqCLBeKro6sPS8ilsz1Q4NRx3v8Ko2IBiszzdww==" crossorigin = "anonymous" > < / script > <!-- pkgdown --> < script src = "../pkgdown.js" > < / script > < meta property = "og:title" content = "Legend properties — ax_legend" > < meta property = "og:description" content = "Legend properties" > <!-- mathjax --> < script src = "https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js" integrity = "sha256-nvJJv9wWKEm88qvoQl9ekL2J+k/RWIsaSScxxlsrv8k=" crossorigin = "anonymous" > < / script > < script src = "https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/config/TeX-AMS-MML_HTMLorMML.js" integrity = "sha256-84DKXVJXs0/F8OTMzX4UR909+jtl4G7SPypPavF+GfA=" crossorigin = "anonymous" > < / script > <!-- [if lt IE 9]>
2021-12-10 17:17:40 +01:00
< script src = "https://oss.maxcdn.com/html5shiv/3.7.3/html5shiv.min.js" > < / script >
< script src = "https://oss.maxcdn.com/respond/1.4.2/respond.min.js" > < / script >
2022-04-02 18:41:16 +02:00
<![endif]--> <!-- dependencies from examples --> < script src = "libs/htmlwidgets-1.5.4/htmlwidgets.js" > < / script > < script src = "libs/apexcharter-binding-0.3.1.9000/apexcharter.js" > < / script > < / head > < body >
2021-12-10 17:17:40 +01:00
< a href = "#main" class = "visually-hidden-focusable" > Skip to contents< / a >
< nav class = "navbar fixed-top navbar-dark navbar-expand-lg bg-primary" > < div class = "container" >
< a class = "navbar-brand me-2" href = "../index.html" > apexcharter< / a >
2022-04-02 18:41:16 +02:00
< small class = "nav-text text-muted me-auto" data-bs-toggle = "tooltip" data-bs-placement = "bottom" title = "" > 0.3.1.9000< / small >
2021-12-10 17:17:40 +01:00
< button class = "navbar-toggler" type = "button" data-bs-toggle = "collapse" data-bs-target = "#navbar" aria-controls = "navbar" aria-expanded = "false" aria-label = "Toggle navigation" >
< span class = "navbar-toggler-icon" > < / span >
< / button >
2022-02-27 17:23:59 +01:00
< div id = "navbar" class = "collapse navbar-collapse ms-3" >
2021-12-10 17:17:40 +01:00
< ul class = "navbar-nav me-auto" > < li class = "nav-item" >
< a class = "nav-link" href = "../articles/apexcharter.html" > Get started< / a >
< / li >
< li class = "active nav-item" >
< a class = "nav-link" href = "../reference/index.html" > Reference< / a >
< / li >
< li class = "nav-item dropdown" >
< a href = "#" class = "nav-link dropdown-toggle" data-bs-toggle = "dropdown" role = "button" aria-expanded = "false" aria-haspopup = "true" id = "dropdown-articles" > Articles< / a >
< div class = "dropdown-menu" aria-labelledby = "dropdown-articles" >
< a class = "dropdown-item" href = "../articles/extra/advanced-configuration.html" > Advanced configuration examples< / a >
< a class = "dropdown-item" href = "../articles/extra/chart-options.html" > Customize chart options< / a >
< a class = "dropdown-item" href = "../articles/extra/facets.html" > Create grid of charts< / a >
< a class = "dropdown-item" href = "../articles/extra/shiny-integration.html" > Use in Shiny application< / a >
< a class = "dropdown-item" href = "../articles/extra/spark-box.html" > Create boxes with sparklines< / a >
< a class = "dropdown-item" href = "../articles/extra/sync-charts.html" > Synchronize charts with each other< / a >
< / div >
< / li >
< li class = "nav-item" >
< a class = "nav-link" href = "../news/index.html" > Changelog< / a >
< / li >
< / ul > < form class = "form-inline my-2 my-lg-0" role = "search" >
< input type = "search" class = "form-control me-sm-2" aria-label = "Toggle navigation" name = "search-input" data-search-index = "../search.json" id = "search-input" placeholder = "Search for" autocomplete = "off" > < / form >
< ul class = "navbar-nav" > < li class = "nav-item" >
< a class = "external-link nav-link" href = "https://github.com/dreamRs/apexcharter/" aria-label = "github" >
< span class = "fab fa fab fa-github fa-lg" > < / span >
< / a >
< / li >
< / ul > < / div >
< / div >
< / nav > < div class = "container template-reference-topic" >
< div class = "row" >
< main id = "main" class = "col-md-9" > < div class = "page-header" >
< img src = "" class = "logo" alt = "" > < h1 > Legend properties< / h1 >
< small class = "dont-index" > Source: < a href = "https://github.com/dreamRs/apexcharter/blob/HEAD/R/apex-utils.R" class = "external-link" > < code > R/apex-utils.R< / code > < / a > < / small >
< div class = "d-none name" > < code > ax_legend.Rd< / code > < / div >
< / div >
< div class = "ref-description section level2" >
< p > Legend properties< / p >
< / div >
< div class = "section level2" >
< h2 id = "ref-usage" > Usage< a class = "anchor" aria-label = "anchor" href = "#ref-usage" > < / a > < / h2 >
< div class = "sourceCode" > < pre class = "sourceCode r" > < code > < span class = "fu" > ax_legend< / span > < span class = "op" > (< / span >
< span class = "va" > ax< / span > ,
show < span class = "op" > =< / span > < span class = "cn" > NULL< / span > ,
position < span class = "op" > =< / span > < span class = "cn" > NULL< / span > ,
showForSingleSeries < span class = "op" > =< / span > < span class = "cn" > NULL< / span > ,
showForNullSeries < span class = "op" > =< / span > < span class = "cn" > NULL< / span > ,
showForZeroSeries < span class = "op" > =< / span > < span class = "cn" > NULL< / span > ,
horizontalAlign < span class = "op" > =< / span > < span class = "cn" > NULL< / span > ,
fontSize < span class = "op" > =< / span > < span class = "cn" > NULL< / span > ,
textAnchor < span class = "op" > =< / span > < span class = "cn" > NULL< / span > ,
offsetY < span class = "op" > =< / span > < span class = "cn" > NULL< / span > ,
offsetX < span class = "op" > =< / span > < span class = "cn" > NULL< / span > ,
formatter < span class = "op" > =< / span > < span class = "cn" > NULL< / span > ,
labels < span class = "op" > =< / span > < span class = "cn" > NULL< / span > ,
markers < span class = "op" > =< / span > < span class = "cn" > NULL< / span > ,
itemMargin < span class = "op" > =< / span > < span class = "cn" > NULL< / span > ,
containerMargin < span class = "op" > =< / span > < span class = "cn" > NULL< / span > ,
onItemClick < span class = "op" > =< / span > < span class = "cn" > NULL< / span > ,
onItemHover < span class = "op" > =< / span > < span class = "cn" > NULL< / span > ,
floating < span class = "op" > =< / span > < span class = "cn" > NULL< / span > ,
< span class = "va" > ...< / span >
< span class = "op" > )< / span > < / code > < / pre > < / div >
< / div >
< div class = "section level2" >
< h2 id = "arguments" > Arguments< a class = "anchor" aria-label = "anchor" href = "#arguments" > < / a > < / h2 >
< dl > < dt > ax< / dt >
< dd > < p > An < code > < a href = "apexchart.html" > apexchart()< / a > < / code > < code > htmlwidget< / code > object.< / p > < / dd >
< dt > show< / dt >
< dd > < p > Logical. Whether to show or hide the legend container.< / p > < / dd >
< dt > position< / dt >
< dd > < p > Available position options for legend: < code > "top"< / code > , < code > "right"< / code > , < code > "bottom"< / code > , < code > "left"< / code > .< / p > < / dd >
< dt > showForSingleSeries< / dt >
< dd > < p > Show legend even if there is just 1 series.< / p > < / dd >
< dt > showForNullSeries< / dt >
< dd > < p > Allows you to hide a particular legend if it's series contains all null values.< / p > < / dd >
< dt > showForZeroSeries< / dt >
< dd > < p > Allows you to hide a particular legend if it's series contains all 0 values.< / p > < / dd >
< dt > horizontalAlign< / dt >
< dd > < p > Available options for horizontal alignment: < code > "right"< / code > , < code > "center"< / code > , < code > "left"< / code > .< / p > < / dd >
< dt > fontSize< / dt >
< dd > < p > Sets the fontSize of legend text elements< / p > < / dd >
< dt > textAnchor< / dt >
< dd > < p > The alignment of text relative to legend's drawing position< / p > < / dd >
< dt > offsetY< / dt >
< dd > < p > Sets the top offset for legend container.< / p > < / dd >
< dt > offsetX< / dt >
< dd > < p > Sets the left offset for legend container.< / p > < / dd >
< dt > formatter< / dt >
< dd > < p > JS function. A custom formatter function to append additional text to the legend series names.< / p > < / dd >
< dt > labels< / dt >
< dd > < p > List with two items < code > "foreColor"< / code > (Custom text color for legend labels)
and < code > "useSeriesColors"< / code > (Logical, whether to use primary colors or not)< / p > < / dd >
< dt > markers< / dt >
< dd > < p > List.< / p > < / dd >
< dt > itemMargin< / dt >
< dd > < p > List with two items < code > "horizontal"< / code > (Horizontal margin for individual legend item)
and < code > "vertical"< / code > (Vertical margin for individual legend item).< / p > < / dd >
< dt > containerMargin< / dt >
< dd > < p > List with two items < code > "top"< / code > (Top margin for the whole legend container)
and < code > "left"< / code > (Left margin for the whole legend container).< / p > < / dd >
< dt > onItemClick< / dt >
< dd > < p > List with item < code > "toggleDataSeries"< / code > , logical,
when clicked on legend item, it will toggle the visibility of the series in chart.< / p > < / dd >
< dt > onItemHover< / dt >
< dd > < p > List with item < code > "highlightDataSeries"< / code > , logical,
when hovered on legend item, it will highlight the paths of the hovered series in chart.< / p > < / dd >
< dt > floating< / dt >
< dd > < p > Logical. The floating option will take out the legend from the chart area and make it float above the chart.< / p > < / dd >
< dt > ...< / dt >
< dd > < p > Additional parameters.< / p > < / dd >
< / dl > < / div >
< div class = "section level2" >
< h2 id = "value" > Value< a class = "anchor" aria-label = "anchor" href = "#value" > < / a > < / h2 >
< p > An < code > < a href = "apexchart.html" > apexchart()< / a > < / code > < code > htmlwidget< / code > object.< / p >
< / div >
< div class = "section level2" >
< h2 id = "note" > Note< a class = "anchor" aria-label = "anchor" href = "#note" > < / a > < / h2 >
< p > See < a href = "https://apexcharts.com/docs/options/legend/" class = "external-link" > https://apexcharts.com/docs/options/legend/< / a > < / p >
< / div >
< div class = "section level2" >
< h2 id = "ref-examples" > Examples< a class = "anchor" aria-label = "anchor" href = "#ref-examples" > < / a > < / h2 >
< div class = "sourceCode" > < pre class = "sourceCode r" > < code > < span class = "r-in" > < span class = "fu" > < a href = "https://rdrr.io/r/utils/data.html" class = "external-link" > data< / a > < / span > < span class = "op" > (< / span > < span class = "st" > "mpg"< / span > , package < span class = "op" > =< / span > < span class = "st" > "ggplot2"< / span > < span class = "op" > )< / span > < / span >
< span class = "r-in" > < / span >
< span class = "r-in" > < span class = "co" > # Legend position< / span > < / span >
< span class = "r-in" > < span class = "fu" > < a href = "apex.html" > apex< / a > < / span > < span class = "op" > (< / span > < / span >
< span class = "r-in" > data < span class = "op" > =< / span > < span class = "va" > mpg< / span > ,< / span >
< span class = "r-in" > mapping < span class = "op" > =< / span > < span class = "fu" > < a href = "apexcharter-exports.html" > aes< / a > < / span > < span class = "op" > (< / span > x < span class = "op" > =< / span > < span class = "va" > manufacturer< / span > , fill < span class = "op" > =< / span > < span class = "va" > year< / span > < span class = "op" > )< / span > < / span >
< span class = "r-in" > < span class = "op" > )< / span > < span class = "op" > < a href = "apexcharter-exports.html" > %> %< / a > < / span > < / span >
< span class = "r-in" > < span class = "fu" > ax_legend< / span > < span class = "op" > (< / span > position < span class = "op" > =< / span > < span class = "st" > "right"< / span > < span class = "op" > )< / span > < / span >
2022-04-02 18:41:16 +02:00
< div id = "htmlwidget-b1c7b96381b72dd2d183" style = "width:700px;height:432.632880098888px;" class = "apexcharter html-widget" > < / div >
< script type = "application/json" data-for = "htmlwidget-b1c7b96381b72dd2d183" > { "x" : { "ax_opts" : { "chart" : { "type" : "bar" } , "series" : [ { "name" : "1999" , "type" : "bar" , "data" : [ { "x" : "audi" , "y" : 9 } , { "x" : "chevrolet" , "y" : 7 } , { "x" : "dodge" , "y" : 16 } , { "x" : "ford" , "y" : 15 } , { "x" : "honda" , "y" : 5 } , { "x" : "hyundai" , "y" : 6 } , { "x" : "jeep" , "y" : 2 } , { "x" : "land rover" , "y" : 2 } , { "x" : "lincoln" , "y" : 2 } , { "x" : "mercury" , "y" : 2 } , { "x" : "nissan" , "y" : 6 } , { "x" : "pontiac" , "y" : 3 } , { "x" : "subaru" , "y" : 6 } , { "x" : "toyota" , "y" : 20 } , { "x" : "volkswagen" , "y" : 16 } ] } , { "name" : "2008" , "type" : "bar" , "data" : [ { "x" : "audi" , "y" : 9 } , { "x" : "chevrolet" , "y" : 12 } , { "x" : "dodge" , "y" : 21 } , { "x" : "ford" , "y" : 10 } , { "x" : "honda" , "y" : 4 } , { "x" : "hyundai" , "y" : 8 } , { "x" : "jeep" , "y" : 6 } , { "x" : "land rover" , "y" : 2 } , { "x" : "lincoln" , "y" : 1 } , { "x" : "mercury" , "y" : 2 } , { "x" : "nissan" , "y" : 7 } , { "x" : "pontiac" , "y" : 2 } , { "x" : "subaru" , "y" : 8 } , { "x" : "toyota" , "y" : 14 } , { "x" : "volkswagen" , "y" : 11 } ] } ] , "dataLabels" : { "enabled" : false } , "plotOptions" : { "bar" : { "horizontal" : false } } , "tooltip" : { "shared" : true , "intersect" : false , "followCursor" : true } , "yaxis" : { "labels" : { "style" : { "colors" : "#848484" } } } , "xaxis" : { "labels" : { "style" : { "colors" : "#848484" } } } , "legend" : { "position" : "right" } } , "auto_update" : { "series_animate" : true , "update_options" : false , "options_animate" : true , "options_redrawPaths" : true , "update_synced_charts" : false } , "sparkbox" : false , "xaxis" : { "min" : "audi" , "max" : "volkswagen" } , "type" : "column" } , "evals" : [ ] , "jsHooks" : [ ] } < / script > < span class = "r-in" > < / span >
2021-12-10 17:17:40 +01:00
< span class = "r-in" > < span class = "co" > # hide legend< / span > < / span >
< span class = "r-in" > < span class = "fu" > < a href = "apex.html" > apex< / a > < / span > < span class = "op" > (< / span > < / span >
< span class = "r-in" > data < span class = "op" > =< / span > < span class = "va" > mpg< / span > ,< / span >
< span class = "r-in" > mapping < span class = "op" > =< / span > < span class = "fu" > < a href = "apexcharter-exports.html" > aes< / a > < / span > < span class = "op" > (< / span > x < span class = "op" > =< / span > < span class = "va" > manufacturer< / span > , fill < span class = "op" > =< / span > < span class = "va" > year< / span > < span class = "op" > )< / span > < / span >
< span class = "r-in" > < span class = "op" > )< / span > < span class = "op" > < a href = "apexcharter-exports.html" > %> %< / a > < / span > < / span >
< span class = "r-in" > < span class = "fu" > ax_legend< / span > < span class = "op" > (< / span > show < span class = "op" > =< / span > < span class = "cn" > FALSE< / span > < span class = "op" > )< / span > < / span >
2022-04-02 18:41:16 +02:00
< div id = "htmlwidget-8edf58d873224043be63" style = "width:700px;height:432.632880098888px;" class = "apexcharter html-widget" > < / div >
< script type = "application/json" data-for = "htmlwidget-8edf58d873224043be63" > { "x" : { "ax_opts" : { "chart" : { "type" : "bar" } , "series" : [ { "name" : "1999" , "type" : "bar" , "data" : [ { "x" : "audi" , "y" : 9 } , { "x" : "chevrolet" , "y" : 7 } , { "x" : "dodge" , "y" : 16 } , { "x" : "ford" , "y" : 15 } , { "x" : "honda" , "y" : 5 } , { "x" : "hyundai" , "y" : 6 } , { "x" : "jeep" , "y" : 2 } , { "x" : "land rover" , "y" : 2 } , { "x" : "lincoln" , "y" : 2 } , { "x" : "mercury" , "y" : 2 } , { "x" : "nissan" , "y" : 6 } , { "x" : "pontiac" , "y" : 3 } , { "x" : "subaru" , "y" : 6 } , { "x" : "toyota" , "y" : 20 } , { "x" : "volkswagen" , "y" : 16 } ] } , { "name" : "2008" , "type" : "bar" , "data" : [ { "x" : "audi" , "y" : 9 } , { "x" : "chevrolet" , "y" : 12 } , { "x" : "dodge" , "y" : 21 } , { "x" : "ford" , "y" : 10 } , { "x" : "honda" , "y" : 4 } , { "x" : "hyundai" , "y" : 8 } , { "x" : "jeep" , "y" : 6 } , { "x" : "land rover" , "y" : 2 } , { "x" : "lincoln" , "y" : 1 } , { "x" : "mercury" , "y" : 2 } , { "x" : "nissan" , "y" : 7 } , { "x" : "pontiac" , "y" : 2 } , { "x" : "subaru" , "y" : 8 } , { "x" : "toyota" , "y" : 14 } , { "x" : "volkswagen" , "y" : 11 } ] } ] , "dataLabels" : { "enabled" : false } , "plotOptions" : { "bar" : { "horizontal" : false } } , "tooltip" : { "shared" : true , "intersect" : false , "followCursor" : true } , "yaxis" : { "labels" : { "style" : { "colors" : "#848484" } } } , "xaxis" : { "labels" : { "style" : { "colors" : "#848484" } } } , "legend" : { "show" : false } } , "auto_update" : { "series_animate" : true , "update_options" : false , "options_animate" : true , "options_redrawPaths" : true , "update_synced_charts" : false } , "sparkbox" : false , "xaxis" : { "min" : "audi" , "max" : "volkswagen" } , "type" : "column" } , "evals" : [ ] , "jsHooks" : [ ] } < / script > < / code > < / pre > < / div >
2021-12-10 17:17:40 +01:00
< / div >
< / main > < aside class = "col-md-3" > < nav id = "toc" > < h2 > On this page< / h2 >
< / nav > < / aside > < / div >
< footer > < div class = "pkgdown-footer-left" >
< p > < / p > < p > Developed by < a href = "https://twitter.com/_pvictorr" class = "external-link" > < img src = "https://pbs.twimg.com/profile_images/844237339404722177/E1U61aM8_normal.jpg" > Victor Perrier< / a > , < a href = "https://twitter.com/_mfaan" class = "external-link" > < img src = "https://pbs.twimg.com/profile_images/912313931326218240/o1-wvA18_normal.jpg" > Fanny Meyer< / a > .< / p >
< / div >
< div class = "pkgdown-footer-right" >
2022-02-27 17:23:59 +01:00
< p > < / p > < p > Site built with < a href = "https://pkgdown.r-lib.org/" class = "external-link" > pkgdown< / a > 2.0.2.< / p >
2021-12-10 17:17:40 +01:00
< / div >
< / footer > < / div >
< / body > < / html >