tinyimg - v1.1.1
    Preparing search index...

    Interface OgOptions

    What og takes.

    interface OgOptions {
        background?: Color;
        color?: Color;
        encode?: EncodeOptions;
        font?: string;
        footer?: string;
        footerSize?: number;
        format?: ImageFormat;
        height?: number;
        image?: Source;
        mutedColor?: Color;
        padding?: number;
        shadow?: boolean;
        subtitle?: string;
        subtitleSize?: number;
        title?: string;
        titleSize?: number;
        width?: number;
    }
    Index
    background? color? encode? font? footer? footerSize? format? height? image? mutedColor? padding? shadow? subtitle? subtitleSize? title? titleSize? width?
    background?: Color

    Solid background color, drawn under everything.

    color?: Color

    Text color. Defaults to white.

    encode?: EncodeOptions

    Encoder settings.

    font?: string

    Blob id of the face to set it in, or omitted for the one the module carries.

    footer?: string

    A small line at the bottom, for a site name or a date.

    footerSize?: number

    Footer size. Defaults to a quarter of the title.

    format?: ImageFormat

    Container to encode as. Defaults to PNG.

    height?: number

    Card height. Defaults to 630.

    image?: Source

    An image to cover the card with, under the text.

    mutedColor?: Color

    Subtitle and footer color. Defaults to OgOptions.color at 70% alpha.

    padding?: number

    How much of the card the text keeps clear of the edges. Defaults to 64.

    shadow?: boolean

    A shadow under the text, which is what keeps a headline readable over a photograph.

    subtitle?: string

    The line under it.

    subtitleSize?: number

    Subtitle size. Defaults to two fifths of the title.

    title?: string

    The headline.

    titleSize?: number

    Title size in pixels. Defaults to a tenth of the height.

    width?: number

    Card width. Defaults to 1200, which is what the OG spec asks for.

    Settings
    Member Visibility

    On This Page
    Properties