Document the new plotly.js makeTemplate function and layout.template attr

[nicolaskruchten]

This feature is pretty cool and needs some docs (or at least I couldn't find any!): https://github.com/plotly/plotly.js/blob/fc0a1f8313abc17d188481eaabd6dfc1a1fb0922/src/plot_api/template_api.js

[alexcjohnson]

#1118 did a great job with makeTemplate/validateTemplate but didn't address layout.template itself though, right?

[michaelbabyn]

@alexcjohnson , right, I'll make another PR showing some examples of creating a template from scratch and the special handling of container arrays.

[nicolaskruchten]

Do we really need to document the format? I figure people can just use makeTemplate...?

…

On Wed, Oct 17, 2018 at 17:22 michaelbabyn ***@***.***> wrote: @alexcjohnson <https://github.com/alexcjohnson> , right, I'll make another PR showing some examples of creating a template from scratch and the special handling of container arrays. — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub <#1111 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AAMbA262upHoeKCWPV7DShptnnXMtfBgks5ul5-CgaJpZM4XGI8X> .

[michaelbabyn]

@nicolaskruchten , I re-looked at https://plot.ly/javascript/reference/#layout-template after we talked and there are some attributes for handling annotations and updatemenus in a template that would be much clearer with some examples.

Container arrays (eg annotations) have special handling: An object ending in defaults (eg annotationdefaults) is applied to each array item. But if an item has a templateitemname key we look in the template array for an item with matching name and apply that instead. If no matching name is found we mark the item invisible. Any named template item not referenced is appended to the end of the array, so you can use this for a watermark annotation or a logo image, for example. To omit one of these items on the plot, make an item with matching templateitemname and visible: false.

[nicolaskruchten]

Ok, makes sense

…

On Wed, Oct 17, 2018 at 18:45 michaelbabyn ***@***.***> wrote: @nicolaskruchten <https://github.com/nicolaskruchten> , I re-looked at https://plot.ly/javascript/reference/#layout-template after we talked and there are some attributes for handling annotations and updatemenus in a template that would be much clearer with some examples. Container arrays (eg annotations) have special handling: An object ending in defaults (eg annotationdefaults) is applied to each array item. But if an item has a templateitemname key we look in the template array for an item with matching name and apply that instead. If no matching name is found we mark the item invisible. Any named template item not referenced is appended to the end of the array, so you can use this for a watermark annotation or a logo image, for example. To omit one of these items on the plot, make an item with matching templateitemname and visible: false. — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#1111 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AAMbA2cA5HLzqMLXPJiv2MOJN2GeY3lrks5ul7MRgaJpZM4XGI8X> .