Interface ShieldDefinitionBase

Parameters that apply to all types of shield definitions

Hierarchy

  • ShieldDefinitionBase

Properties

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

Properties

Optional bannerMap

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

Map of additional networks that are bannered variants of this one

Type declaration

  • [key: string]: string[]

Optional bannerTextColor

bannerTextColor?: string

Color of banner text

Optional bannerTextHaloColor

bannerTextHaloColor?: string

Color of banner text halo

Optional banners

banners?: string[]

Banners to be drawn above a shield

colorDarken

colorDarken: string

Perform a color darken operation with this color

colorLighten

colorLighten: string

Perform a color lighten operation with this color

Optional maxFontSize

maxFontSize?: number

Maximum size of shield text

noref

noref: ShieldDefinition

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

Optional notext

notext?: boolean

If true, no next should be drawn on this shield

Optional numberingSystem

numberingSystem?: string

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

overrideByName

overrideByName: Map<string, ShieldDefinition>

Provide a different shield style for specific name values

overrideByRef

overrideByRef: Map<string, ShieldDefinition>

Provide a different shield style for specific ref values

Optional padding

padding?: BoxPadding

Padding around shield text

Optional ref

ref?: string

hard-code the shield text to this value

Optional refsByName

refsByName?: Map<string, string>

ref values that can be mapped from names

Optional textColor

textColor?: string

Color of text drawn on a shield

Optional textHaloColor

textHaloColor?: string

Color of the halo drawn around text

Optional textLayout

textLayout?: TextLayout

Algorithm for expanding text to fill a shield background

verticalReflect

verticalReflect: boolean

Reflect this shield vertically

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc