• Draws a shield with an octagon background

    Parameters

    • yOffset: number

      Height of diagonal edges

    • sideAngle: number

      Angle (in degrees) at which sides deviate from vertical

    • fillColor: string

      Color of octagon background fill

    • strokeColor: string

      Color of octagon outline stroke

    • textColor: string

      Color of text (defaults to strokeColor)

    • radius: number

      Corner radius of octagon (defaults to 2)

    • rectWidth: number

      Width of octagon (defaults to variable-width)

    Returns Partial<ShieldDefinition>

    a shield definition object

Generated using TypeDoc