docstr: Template string used for rendering the information that appear
  on hover box. Note that this will override `hoverinfo`.
  Variables are inserted using %{variable}, for example "y: %{y}"
  as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When
  showing info for several points, "xother" will be added to
  those with different x positions from the first point. An
  underscore before or after "(x|y)other" will add a space on
  that side, only when this field is shown. Numbers are formatted
  using d3-format's syntax %{variable:d3-format}, for example
  "Price: %{y:$.2f}".
  https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
  details on the formatting syntax. Dates are formatted using
  d3-time-format's syntax %{variable|d3-time-format}, for example
  "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-
  format/tree/v2.2.3#locale_format for details on the date
  formatting syntax. The variables available in `hovertemplate`
  are the ones emitted as event data described at this link
  https://plotly.com/javascript/plotlyjs-events/#event-data.
  Additionally, every attributes that can be specified per-point
  (the ones that are `arrayOk: true`) are available.  This value
  here applies when hovering over dimensions. Note that
  `*categorycount`, "colorcount" and "bandcolorcount" are only
  available when `hoveron` contains the "color" flagFinally, the
  template string has access to variables `count`, `probability`,
  `category`, `categorycount`, `colorcount` and `bandcolorcount`.
  Anything contained in tag `<extra>` is displayed in the
  secondary box, for example "<extra>{fullData.name}</extra>". To
  hide the secondary box completely, use an empty tag
  `<extra></extra>`.
  
  The 'hovertemplate' property is a string and must be specified as:
    - A string
    - A number that will be converted to a string
  
  Returns
  -------
  str
docstr_tok: ["Template","string","used","for","rendering","the","information","that","appear","on","hover","box",".","Note","that","this","will","override","`","hoverinfo","`",".","Variables","are","inserted","using","%","{","variable","}",",","for","example","``","y",":","%","{","y","}","''","as","well","as","%","{","xother","}",",","{","%","_xother","}",",","{","%","_xother_","}",",","{","%","xother_","}",".","When","showing","info","for","several","points",",","``","xother","''","will","be","added","to","those","with","different","x","positions","from","the","first","point",".","An","underscore","before","or","after","``","(","x|y",")","other","''","will","add","a","space","on","that","side",",","only","when","this","field","is","shown",".","Numbers","are","formatted","using","d3-format","'s","syntax","%","{","variable",":","d3-format","}",",","for","example","''","Price",":","%","{","y",":","$",".2f","}","''",".","https",":","\/\/github.com\/d3\/d3-format\/tree\/v1.4.5","#","d3-format","for","details","on","the","formatting","syntax",".","Dates","are","formatted","using","d3-time-format","'s","syntax","%","{","variable|d3-time-format","}",",","for","example","''","Day",":","%","{","2019-01-01|","%","A","}","''",".","https",":","\/\/github.com\/d3\/d3-time-","format\/tree\/v2.2.3","#","locale_format","for","details","on","the","date","formatting","syntax",".","The","variables","available","in","`","hovertemplate","`","are","the","ones","emitted","as","event","data","described","at","this","link","https",":","\/\/plotly.com\/javascript\/plotlyjs-events\/","#","event-data",".","Additionally",",","every","attributes","that","can","be","specified","per-point","(","the","ones","that","are","`","arrayOk",":","true","`",")","are","available",".","This","value","here","applies","when","hovering","over","dimensions",".","Note","that","`","*","categorycount","`",",","``","colorcount","''","and","``","bandcolorcount","''","are","only","available","when","`","hoveron","`","contains","the","``","color","''","flagFinally",",","the","template","string","has","access","to","variables","`","count","`",",","`","probability","`",",","`","category","`",",","`","categorycount","`",",","`","colorcount","`","and","`","bandcolorcount","`",".","Anything","contained","in","tag","`","<","extra",">","`","is","displayed","in","the","secondary","box",",","for","example","``","<","extra",">","{","fullData.name","}","<","\/extra",">","''",".","To","hide","the","secondary","box","completely",",","use","an","empty","tag","`","<","extra",">","<","\/extra",">","`",".","The","'hovertemplate","'","property","is","a","string","and","must","be","specified","as",":","-","A","string","-","A","number","that","will","be","converted","to","a","string","Returns","--","--","--","-","str"]
code: def hovertemplate(self):
      """
      Template string used for rendering the information that appear
      on hover box. Note that this will override `hoverinfo`.
      Variables are inserted using %{variable}, for example "y: %{y}"
      as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When
      showing info for several points, "xother" will be added to
      those with different x positions from the first point. An
      underscore before or after "(x|y)other" will add a space on
      that side, only when this field is shown. Numbers are formatted
      using d3-format's syntax %{variable:d3-format}, for example
      "Price: %{y:$.2f}".
      https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
      details on the formatting syntax. Dates are formatted using
      d3-time-format's syntax %{variable|d3-time-format}, for example
      "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-
      format/tree/v2.2.3#locale_format for details on the date
      formatting syntax. The variables available in `hovertemplate`
      are the ones emitted as event data described at this link
      https://plotly.com/javascript/plotlyjs-events/#event-data.
      Additionally, every attributes that can be specified per-point
      (the ones that are `arrayOk: true`) are available.  This value
      here applies when hovering over dimensions. Note that
      `*categorycount`, "colorcount" and "bandcolorcount" are only
      available when `hoveron` contains the "color" flagFinally, the
      template string has access to variables `count`, `probability`,
      `category`, `categorycount`, `colorcount` and `bandcolorcount`.
      Anything contained in tag `<extra>` is displayed in the
      secondary box, for example "<extra>{fullData.name}</extra>". To
      hide the secondary box completely, use an empty tag
      `<extra></extra>`.
  
      The 'hovertemplate' property is a string and must be specified as:
        - A string
        - A number that will be converted to a string
  
      Returns
      -------
      str
      """
      return self["hovertemplate"]
  
imports: from plotly.basedatatypes import BaseTraceType
  import copy
label_desc: Use image node_id 19 for calling the Parcats obj's underlying member method code with example usage: obj.hovertemplate() and returns: self