plotly / plotly/plotly.R

confusing API for heatmap legend

Ouverte
#2,086 1 commentaire 1 réaction 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Langage dominant
R
Étoiles
2.7k
Forks
641
Métriques de merge des PR
Aucune PR mergée en 30 j

Description

When trying to customize the legend for a heatmap I would expect that to be done through the layout similar to other trace types.

plot_ly(
  z = volcano, 
  type = "heatmap",
) %>%
  layout(
    legend = list(
      title = list(
        text = "custom title"
      )
    )
  )

After digging around for a while and examining the output of plotly_build() %>% plotly_json() I found that this is done through the top level colorbar instead.

plot_ly(
  z = volcano, 
  type = "heatmap",
  colorbar = list(
    title = "custom title"
  )
) 

I would say that if the interface for this needs to be different than for other traces, that should be documented on the heatmap page. Even better may be to standardize the approach so that users always know to go to layout for this type of thing.

I'm also curious why colorbar title is shown as a deprecated attribute from schema().
Screen Shot 2021-12-11 at 7 56 04 AM

Guide de contribution

Ouvrir le guide de contribution

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Piste de recherche

Commencez par la page de heatmap R liée dans l’issue et examinez les exemples documentés ainsi que la sortie de plotly_build() et plotly_json() qui y est décrite. Documentez que la personnalisation de la légende de la heatmap utilise le colorbar de niveau supérieur, y compris le détail de la dépréciation de schema() ; le travail est terminé lorsqu’une personne débutante peut trouver et suivre l’interface documentée.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
r
Domaine
data-visualization
Type d'issue
Documentation
Difficulté
2/5
Temps estimé
1-3 heures
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
45/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.