@americana/maplibre-shield-generator
    Preparing search index...

    Interface ShieldDefinitionBase

    Parameters that apply to all types of shield definitions

    interface ShieldDefinitionBase {
        bannerMap?: { [key: string]: string[] };
        banners?: string[];
        bannerTextColor?: string;
        bannerTextHaloColor?: string;
        colorDarken: string;
        colorLighten: string;
        maxFontSize?: number;
        noref: ShieldDefinition;
        notext?: boolean;
        numberingSystem?: string;
        overrideByName: Map<string, ShieldDefinition>;
        overrideByRef: Map<string, ShieldDefinition>;
        padding?: BoxPadding;
        ref?: string;
        refsByName?: Map<string, string>;
        textColor?: string;
        textHaloColor?: string;
        textLayout?: TextLayout;
        verticalReflect: boolean;
    }
    Index

    Properties

    bannerMap? banners? bannerTextColor? bannerTextHaloColor? colorDarken colorLighten maxFontSize? noref notext? numberingSystem? overrideByName overrideByRef padding? ref? refsByName? textColor? textHaloColor? textLayout? verticalReflect

    Properties

    bannerMap?: { [key: string]: string[] }

    Map of additional networks that are bannered variants of this one

    banners?: string[]

    Banners to be drawn above a shield

    bannerTextColor?: string

    Color of banner text

    bannerTextHaloColor?: string

    Color of banner text halo

    colorDarken: string

    Perform a color darken operation with this color

    colorLighten: string

    Perform a color lighten operation with this color

    maxFontSize?: number

    Maximum size of shield text

    noref: ShieldDefinition

    Provide a different shield style when there's no ref value

    notext?: boolean

    If true, no next should be drawn on this shield

    numberingSystem?: string

    Transpose numbering system, for example "roman" for Roman numerals

    overrideByName: Map<string, ShieldDefinition>

    Provide a different shield style for specific name values

    overrideByRef: Map<string, ShieldDefinition>

    Provide a different shield style for specific ref values

    padding?: BoxPadding

    Padding around shield text

    ref?: string

    hard-code the shield text to this value

    refsByName?: Map<string, string>

    ref values that can be mapped from names

    textColor?: string

    Color of text drawn on a shield

    textHaloColor?: string

    Color of the halo drawn around text

    textLayout?: TextLayout

    Algorithm for expanding text to fill a shield background

    verticalReflect: boolean

    Reflect this shield vertically

    Settings

    Member Visibility

    On This Page

    Properties