2021-07-23 11:19:23 +02:00
<!DOCTYPE html>
2021-10-20 18:23:29 +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-4.6.0/bootstrap.min.css" rel = "stylesheet" > < script src = "../deps/bootstrap-4.6.0/bootstrap.bundle.min.js" > < / script > < script src = "../deps/bs3compat-0.3.1/transition.js" > < / script > < script src = "../deps/bs3compat-0.3.1/tabs.js" > < / script > < script src = "../deps/bs3compat-0.3.1/bs3compat.js" > < / script > <!-- 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 --> < link href = "../pkgdown.css" rel = "stylesheet" > < link href = "../syntax-highlighting.css" rel = "stylesheet" > < 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-07-23 11:19:23 +02: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 >
<![endif]--> < / head > < body data-spy = "scroll" data-target = "#toc" data-headroom >
< nav class = "navbar fixed-top navbar-dark navbar-expand-lg bg-primary" > < div class = "container" >
< a class = "navbar-brand mb-0 h1" href = "../index.html" > apexcharter< / a >
< button class = "navbar-toggler" type = "button" data-toggle = "collapse" data-target = "#navbar" aria-controls = "navbar" aria-expanded = "false" aria-label = "Toggle navigation" >
< span class = "navbar-toggler-icon" > < / span >
< / button >
2021-10-20 18:23:29 +02:00
< button type = "button" id = "version-badge" class = "badge badge-default d-none d-lg-block" data-toggle = "tooltip" data-placement = "bottom" title = "" data-original-title = "Released version" > 0.2.0.9200< / button >
2021-07-23 11:19:23 +02:00
< div id = "navbar" class = "collapse navbar-collapse" >
< ul class = "navbar-nav mr-auto ml-3" > < 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-toggle = "dropdown" role = "button" aria-expanded = "false" aria-haspopup = "true" id = "dropdown-articles" > Articles< / a >
< div class = "dropdown-menu" aria-labelledby = "dropdown-articles" >
2021-10-20 18:23:29 +02:00
< a class = "dropdown-item" href = "../articles/extra/advanced-configuration.html" > Advanced configuration examples< / a >
< a class = "dropdown-item" href = "../articles/extra/chart-options.html" > Chart options< / a >
< a class = "dropdown-item" href = "../articles/extra/facets.html" > Facets: grid of charts< / a >
< a class = "dropdown-item" href = "../articles/extra/shiny-integration.html" > Shiny integration< / a >
< a class = "dropdown-item" href = "../articles/extra/spark-box.html" > Spark boxes< / a >
< a class = "dropdown-item" href = "../articles/extra/sync-charts.html" > Syncing charts< / a >
2021-07-23 11:19:23 +02:00
< / 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 mr-sm-2" aria-label = "Search" name = "search-input" data-search-index = "/search.json" id = "search-input" placeholder = "Search..." autocomplete = "off" > < / form >
< ul class = "navbar-nav ml-1" > < li class = "nav-item" >
< a class = "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" >
< div class = "col-md-9 contents" >
< img src = "" class = "pkg-logo" alt = "" > < div class = "page-header pb-2 mt-4 mb-2 border-bottom toc-ignore" >
< h1 class = "display-4" > Legend properties< / h1 >
< small class = "dont-index" > Source: < a href = "https://github.com/dreamRs/apexcharter/blob/master/R/apex-utils.R" > < 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 id = "ref-usage" class = "ref-usage section level2 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 >
< h2 > Arguments< / h2 >
< dl class = "row" id = "ref-arguments" > < dt class = "col-sm-3 section level2" id = "pkg-arg-ax" > ax< / dt >
< dd class = "col-sm-9" id = "ref-arguments desc" > < p > A < code > apexcharts< / code > < code > htmlwidget< / code > object.< / p > < / dd >
< dt class = "col-sm-3 section level2" id = "pkg-arg-show" > show< / dt >
< dd class = "col-sm-9" id = "ref-arguments desc" > < p > Logical. Whether to show or hide the legend container.< / p > < / dd >
< dt class = "col-sm-3 section level2" id = "pkg-arg-position" > position< / dt >
< dd class = "col-sm-9" id = "ref-arguments desc" > < p > Available position options for legend: < code > "top"< / code > , < code > "right"< / code > , < code > "bottom"< / code > , < code > "left"< / code > .< / p > < / dd >
< dt class = "col-sm-3 section level2" id = "pkg-arg-showForSingleSeries" > showForSingleSeries< / dt >
< dd class = "col-sm-9" id = "ref-arguments desc" > < p > Show legend even if there is just 1 series.< / p > < / dd >
< dt class = "col-sm-3 section level2" id = "pkg-arg-showForNullSeries" > showForNullSeries< / dt >
< dd class = "col-sm-9" id = "ref-arguments desc" > < p > Allows you to hide a particular legend if it's series contains all null values.< / p > < / dd >
< dt class = "col-sm-3 section level2" id = "pkg-arg-showForZeroSeries" > showForZeroSeries< / dt >
< dd class = "col-sm-9" id = "ref-arguments desc" > < p > Allows you to hide a particular legend if it's series contains all 0 values.< / p > < / dd >
< dt class = "col-sm-3 section level2" id = "pkg-arg-horizontalAlign" > horizontalAlign< / dt >
< dd class = "col-sm-9" id = "ref-arguments desc" > < p > Available options for horizontal alignment: < code > "right"< / code > , < code > "center"< / code > , < code > "left"< / code > .< / p > < / dd >
< dt class = "col-sm-3 section level2" id = "pkg-arg-fontSize" > fontSize< / dt >
< dd class = "col-sm-9" id = "ref-arguments desc" > < p > Sets the fontSize of legend text elements< / p > < / dd >
< dt class = "col-sm-3 section level2" id = "pkg-arg-textAnchor" > textAnchor< / dt >
< dd class = "col-sm-9" id = "ref-arguments desc" > < p > The alignment of text relative to legend's drawing position< / p > < / dd >
< dt class = "col-sm-3 section level2" id = "pkg-arg-offsetY" > offsetY< / dt >
< dd class = "col-sm-9" id = "ref-arguments desc" > < p > Sets the top offset for legend container.< / p > < / dd >
< dt class = "col-sm-3 section level2" id = "pkg-arg-offsetX" > offsetX< / dt >
< dd class = "col-sm-9" id = "ref-arguments desc" > < p > Sets the left offset for legend container.< / p > < / dd >
< dt class = "col-sm-3 section level2" id = "pkg-arg-formatter" > formatter< / dt >
< dd class = "col-sm-9" id = "ref-arguments desc" > < p > JS function. A custom formatter function to append additional text to the legend series names.< / p > < / dd >
< dt class = "col-sm-3 section level2" id = "pkg-arg-labels" > labels< / dt >
< dd class = "col-sm-9" id = "ref-arguments desc" > < 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 class = "col-sm-3 section level2" id = "pkg-arg-markers" > markers< / dt >
< dd class = "col-sm-9" id = "ref-arguments desc" > < p > List.< / p > < / dd >
< dt class = "col-sm-3 section level2" id = "pkg-arg-itemMargin" > itemMargin< / dt >
< dd class = "col-sm-9" id = "ref-arguments desc" > < 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 class = "col-sm-3 section level2" id = "pkg-arg-containerMargin" > containerMargin< / dt >
< dd class = "col-sm-9" id = "ref-arguments desc" > < 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 class = "col-sm-3 section level2" id = "pkg-arg-onItemClick" > onItemClick< / dt >
< dd class = "col-sm-9" id = "ref-arguments desc" > < 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 class = "col-sm-3 section level2" id = "pkg-arg-onItemHover" > onItemHover< / dt >
< dd class = "col-sm-9" id = "ref-arguments desc" > < 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 class = "col-sm-3 section level2" id = "pkg-arg-floating" > floating< / dt >
< dd class = "col-sm-9" id = "ref-arguments desc" > < p > Logical. The floating option will take out the legend from the chart area and make it float above the chart.< / p > < / dd >
< dt class = "col-sm-3 section level2" id = "pkg-arg-..." > ...< / dt >
< dd class = "col-sm-9" id = "ref-arguments desc" > < p > Additional parameters.< / p > < / dd >
< / dl > < div class = "ref-section section level2" id = "section-value" >
< h2 class = "hasAnchor" id = "value" > < a class = "anchor" href = "#value" aria-hidden = "true" > < / a > Value< / h2 >
< p > A < code > apexcharts< / code > < code > htmlwidget< / code > object.< / p >
< / div >
< div class = "ref-section section level2" id = "section-note" >
< h2 class = "hasAnchor" id = "note" > < a class = "anchor" href = "#note" aria-hidden = "true" > < / a > Note< / h2 >
< p > See < a href = "https://apexcharts.com/docs/options/legend/" > https://apexcharts.com/docs/options/legend/< / a > < / p >
< / div >
< h2 class = "hasAnchor" id = "examples" > < a class = "anchor" href = "#examples" aria-hidden = "true" > < / a > Examples< / h2 >
< div class = "ref-examples sourceCode" > < pre class = "sourceCode r" > < code > < span class = "r-in" > < span class = "fu" > < a href = "https://rdrr.io/r/utils/data.html" > 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 >
< span class = "r-in" > < / span >
< 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 >
< / code > < / pre > < / div >
< / div >
< div class = "col-md-3 hidden-xs hidden-sm" id = "pkgdown-sidebar" >
< div class = "sticky-top" >
< nav id = "toc" > < h2 data-toc-skip > Contents< / h2 >
< / nav > < / div >
< / div >
< / 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" >
< p > < / p > < p > Site built with < a href = "https://pkgdown.r-lib.org/" class = "external-link" > pkgdown< / a > 1.6.1.9001.< / p >
< / div >
< / footer > < / div >
< / body > < / html >