Important: This documentation is about an older version. It's relevant only to the release noted, many of the features and functions have been updated or replaced. Please view the current version.

Documentationbreadcrumb arrow Grafana documentationbreadcrumb arrow API Referencebreadcrumb arrow @grafana/uibreadcrumb arrow VizLayoutLegendProps
Enterprise Open source

VizLayoutLegendProps interface

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Signature

typescript 
export interface VizLayoutLegendProps

Import

typescript 
import { VizLayoutLegendProps } from '@grafana/ui';

Properties

PropertyTypeDescription
childrenReact.ReactNode(BETA)
maxHeightstring(BETA)
maxWidthstring(BETA)
placementLegendPlacement(BETA)

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

children property

Signature

typescript 
children: React.ReactNode;

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

maxHeight property

Signature

typescript 
maxHeight?: string;

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

maxWidth property

Signature

typescript 
maxWidth?: string;

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

placement property

Signature

typescript 
placement: LegendPlacement;