---
url: /api/plugins/pantoken/logos/src/functions/getLogoMeta.md
---
[pantoken-root](../../../../../index.md) / [plugins/pantoken/logos/src](../index.md) / getLogoMeta

# Function: getLogoMeta()

> **getLogoMeta**(`product`, `layout?`, `colorMode?`, `lang?`): [`LogoMeta`](../interfaces/LogoMeta.md) | `undefined`

Beta

Get a logo's metadata, including its natural `viewBox` `width`/`height` — for consumers that need
the logo's real aspect ratio (e.g. to set `aspect-ratio` or `width`/`height` on an `<img>`) without
parsing SVG themselves.

## Parameters

### product

[`Product`](../type-aliases/Product.md)

The product.

### layout?

[`LogoLayout`](../type-aliases/LogoLayout.md) = `"horizontal"`

The layout (default `"horizontal"`).

### colorMode?

[`LogoColorMode`](../type-aliases/LogoColorMode.md) = `"full-color"`

The color treatment (default `"full-color"`).

### lang?

[`LogoLang`](../type-aliases/LogoLang.md)

The localized wordmark's language, if a translated variant is wanted.

## Returns

[`LogoMeta`](../interfaces/LogoMeta.md) | `undefined`

The [LogoMeta](../interfaces/LogoMeta.md), or `undefined` if that combination doesn't exist.

## Example

**Read a logo's aspect ratio**

```ts
import { getLogoMeta } from "@pantoken/plugin-logos";

const meta = getLogoMeta("canvas", "horizontal", "color");
meta && meta.width / meta.height; // the logo's real aspect ratio
```