text template

mahdis-z · mahdis-z · commit e9ade1e52eca · 2020-02-27T15:37:38.000-05:00
diff --git a/r/2015-07-30-text-and-annotations.Rmd b/r/2015-07-30-text-and-annotations.Rmd
@@ -365,7 +365,73 @@ fig <- fig %>% add_annotations(
 
 fig
 ```
+### Customize Displayed Text with a Text Template
 
+To show an arbitrary text in your chart you can use [texttemplate](https://plot.ly/r/reference/#pie-texttemplate), which is a template string used for rendering the information, and will override [textinfo](https://plot.ly/r/reference/#treemap-textinfo).
+This template string can include `variables` in %{variable} format, `numbers` in [d3-format's syntax](https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_forma), and `date` in [d3-time-fomrat's syntax](https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md#format).
+`texttemplate` customizes the text that appears on your plot vs. [hovertemplate](https://plot.ly/r/reference/#pie-hovertemplate) that customizes the tooltip text.
+
+```{r}
+library(plotly)
+
+fig <- plot_ly(
+  type='pie',
+  values=c(40000000, 20000000, 30000000, 10000000),
+  labels=c("Wages", "Operating expenses", "Cost of sales", "Insurance"),
+  texttemplate="%{label}: %{value:$,s} <br>(%{percent})",
+  textposition="inside")
+fig
+```
+
+### Customize Text Template
+
+The following example uses [textfont](https://plot.ly/r/reference/#scatterternary-textfont) to customize the added text.
+
+```{r}
+library(plotly)
+
+fig <- plot_ly(
+  type='scatterternary',
+  a = c(3, 2, 5),
+  b = c(2, 5, 2),
+  c = c(5, 2, 2),
+  mode = "markers+text",
+  text = c("A", "B", "C"),
+  texttemplate = "%{text}<br>(%{a:.2f}, %{b:.2f}, %{c:.2f})",
+  textposition = "bottom center",
+  textfont = list(family= "Times", size= c(18, 21, 20), color= c("IndianRed", "MediumPurple", "DarkOrange"))
+)
+fig
+```
+### Set Date in Text Template
+
+The following example shows how to show date by setting [axis.type](https://plot.ly/r/reference/#layout-yaxis-type) in [funnel charts](https://plot.ly/r/funnel-charts/).
+As you can see [textinfo](https://plot.ly/r/reference/#funnel-textinfo) and [texttemplate](https://plot.ly/r/reference/#funnel-texttemplate) have the same functionality when you want to determine 'just' the trace information on the graph.
+
+```{r}
+fig <- plot_ly()
+
+fig <- fig %>% add_trace(
+  type='funnel',
+  name = 'Montreal',
+  orientation = "h",
+  y = c("2018-01-01", "2018-07-01", "2019-01-01", "2020-01-01"),
+  x = c(100, 60, 40, 20),
+  textposition = "inside",
+  texttemplate = "%{y| %a. %_d %b %Y}")
+
+fig <- fig %>% add_trace(
+  type='funnel',
+  name = 'Vancouver',
+  orientation = "h",
+  y = c("2018-01-01", "2018-07-01", "2019-01-01", "2020-01-01"),
+  x = c(90, 70, 50, 10),
+  textposition = "inside",
+  textinfo = "label")
+
+fig <- fig %>% layout(yaxis = list(type= 'date'))
+fig
+```
 ### Set Annotation Coordinate References
 
 ```{r}
