annotation_legend_size-HeatmapList-method {ComplexHeatmap} | R Documentation

## Size of the annotation legend viewport

### Description

Size of the annotation legend viewport

### Usage

    ## S4 method for signature 'HeatmapList'
    annotation_legend_size(object, legend_list = list(), ...)

### Arguments

`object` | a `HeatmapList-class` object.
`legend_list` | a list of self-defined legend, should be wrapped into `grob` objects.
`...` | graphic parameters passed to `color_mapping_legend,ColorMapping-method`.

### Details

Legends for all heatmaps or legends for all annotations will be put in one viewport. This function calculates the size of such viewport. Note graphic parameters for legends will affect the size.

This function is only for internal use.

### Value

A `unit` object.

### Author(s)

Zuguang Gu <z.gu@dkfz.de>

### Examples

    # no example for this internal method
    NULL

[Package ComplexHeatmap version 1.18.1 Index]