man/draw_heatmap_legend-HeatmapList-method.Rd
d1da987e
 \name{draw_heatmap_legend-HeatmapList-method}
 \alias{draw_heatmap_legend,HeatmapList-method}
c94e524a
 \alias{draw_heatmap_legend}
d1da987e
 \title{
3c40a7c1
 Draw legends for All Heatmaps
d1da987e
 }
 \description{
3c40a7c1
 Draw legends for All Heatmaps
d1da987e
 }
 \usage{
ba8a5070
 \S4method{draw_heatmap_legend}{HeatmapList}(object, legend_list = list(), ...)
 }
d1da987e
 \arguments{
 
3c40a7c1
   \item{object}{A \code{\link{HeatmapList-class}} object.}
7ba2bb40
   \item{legend_list}{A list of self-defined legends, should be wrapped into \code{\link[grid:grid.grob]{grob}} objects. It is normally constructed by \code{\link{Legend}}.}
3c40a7c1
   \item{...}{Other arguments.}
ba8a5070
 
d1da987e
 }
 \details{
3c40a7c1
 Actually we call the "heatmap legends" as the main legends.
 For horizontal heatmap list, the legends are those from heamtap/row annotation/left/right annotation.
 For vertical heatmap list, the legends are those from heamtap/column annotation/top/bottom annotation.
 if \code{merge_legends} is true in \code{\link{draw,HeatmapList-method}}, then it contains all legends shown on the plot.
 
6f1307c6
 A viewport is created which contains heatmap legends.
7ab3fd24
 
6f1307c6
 This function is only for internal use.
d1da987e
 }
 \value{
6f1307c6
 This function returns no value.
d1da987e
 }
 \author{
6f1307c6
 Zuguang Gu <z.gu@dkfz.de>
d1da987e
 }
 \examples{
ad35494a
 # There is no example
f597719b
 NULL
c94e524a
 
f597719b
 }