Class ShieldRenderer

A shield renderer configured from a JSON specification

Example

const shields = {
    "US:I": {
        textColor: Color.shields.white,
        spriteBlank: ["shield_us_interstate_2", "shield_us_interstate_3"],
        textLayout: textConstraint("southHalfEllipse"),
        padding: {
            left: 4,
            right: 4,
            top: 6,
            bottom: 5,
        },
    }
};

const shieldRenderer = new ShieldRenderer(shields, routeParser)
    .filterImageID(shieldPredicate)
    .filterNetwork(networkPredicate)
    .renderOnMaplibreGL(map)
    .onShieldDefLoad((shields) => afterShieldRendererLoads(shields)); //Post config

Hierarchy (View Summary)

AbstractShieldRenderer
- ShieldRenderer

Index

Constructors

constructor

Methods

createGraphics debugOptions emptySprite filterImageID filterNetwork getGraphicForRoute getShieldDefinitions getStyleImageMissingHandler graphicsFactory onShieldDefLoad pixelRatio renderOnMaplibreGL renderOnRepository setShields

Constructors

constructor

new ShieldRenderer(
shieldSpec: ShieldSpecification,
routeParser: RouteParser,
): ShieldRenderer
Parameters
- shieldSpec: ShieldSpecification
- routeParser: RouteParser
Returns ShieldRenderer
Overrides AbstractShieldRenderer.constructor
- Defined in shield_renderer.ts:310

Methods

createGraphics

createGraphics(bounds: Bounds): CanvasRenderingContext2D
Get a blank route shield graphics context in a specified size
Parameters
- bounds: Bounds
Returns CanvasRenderingContext2D
Inherited from AbstractShieldRenderer.createGraphics
- Defined in shield_renderer.ts:274

debugOptions

debugOptions(debugOptions: DebugOptions): AbstractShieldRenderer
Set debugging options
Parameters
- debugOptions: DebugOptions
Returns AbstractShieldRenderer
Inherited from AbstractShieldRenderer.debugOptions
- Defined in shield_renderer.ts:165

emptySprite

emptySprite(): CanvasRenderingContext2D
Get a blank route shield sprite in the default size

Returns CanvasRenderingContext2D
Inherited from AbstractShieldRenderer.emptySprite
- Defined in shield_renderer.ts:269

filterImageID

filterImageID(shieldPredicate: StringPredicate): AbstractShieldRenderer
Set which unhandled sprite IDs this renderer handles
Parameters
- shieldPredicate: StringPredicate
Returns AbstractShieldRenderer
Inherited from AbstractShieldRenderer.filterImageID
- Defined in shield_renderer.ts:171

filterNetwork

filterNetwork(networkPredicate: StringPredicate): AbstractShieldRenderer
Set which network values this renderer handles
Parameters
- networkPredicate: StringPredicate
Returns AbstractShieldRenderer
Inherited from AbstractShieldRenderer.filterNetwork
- Defined in shield_renderer.ts:179

getGraphicForRoute

getGraphicForRoute(
    network: string,
    ref: string,
    name: string,
): CanvasRenderingContext2D
Get the graphic for a specified route
Parameters
- network: string
- ref: string
- name: string
Returns CanvasRenderingContext2D
Inherited from AbstractShieldRenderer.getGraphicForRoute
- Defined in shield_renderer.ts:260

getShieldDefinitions

getShieldDefinitions(): ShieldDefinitions
Get the shield definitions

Returns ShieldDefinitions
Inherited from AbstractShieldRenderer.getShieldDefinitions
- Defined in shield_renderer.ts:160

getStyleImageMissingHandler

getStyleImageMissingHandler(): (e: MapStyleImageMissingEvent) => void
Get the handler function for styleimagemissing event calls

See MapStyleImageMissingEvent for more details.

Returns (e: MapStyleImageMissingEvent) => void
Inherited from AbstractShieldRenderer.getStyleImageMissingHandler
- Defined in shield_renderer.ts:236

graphicsFactory

graphicsFactory(gfxFactory: GraphicsFactory): AbstractShieldRenderer
Set which graphics context to draw shields to
Parameters
- gfxFactory: GraphicsFactory
Returns AbstractShieldRenderer
Inherited from AbstractShieldRenderer.graphicsFactory
- Defined in shield_renderer.ts:187

onShieldDefLoad

onShieldDefLoad(
callback: (shields: ShieldDefinitions) => void,
): AbstractShieldRenderer
Set a callback that fires when shield definitions are loaded
Parameters
- callback: (shields: ShieldDefinitions) => void
Returns AbstractShieldRenderer
Inherited from AbstractShieldRenderer.onShieldDefLoad
- Defined in shield_renderer.ts:212

pixelRatio

pixelRatio(): number
Get the current pixel ration (1x/2x)

Returns number
Inherited from AbstractShieldRenderer.pixelRatio
- Defined in shield_renderer.ts:279

renderOnMaplibreGL

renderOnMaplibreGL(map: Map): AbstractShieldRenderer
Set which MaplibreGL map to handle shields for
Parameters
- map: Map
Returns AbstractShieldRenderer
Inherited from AbstractShieldRenderer.renderOnMaplibreGL
- Defined in shield_renderer.ts:193

renderOnRepository

renderOnRepository(repo: SpriteRepository): AbstractShieldRenderer
Set the storage location for existing and generated sprite images
Parameters
- repo: SpriteRepository
Returns AbstractShieldRenderer
Inherited from AbstractShieldRenderer.renderOnRepository
- Defined in shield_renderer.ts:224

`Protected`setShields

setShields(shieldSpec: ShieldSpecification): void
Specify which shields to draw and with what graphics
Parameters
- shieldSpec: ShieldSpecification
Returns void
Inherited from AbstractShieldRenderer.setShields
- Defined in shield_renderer.ts:106

Class ShieldRenderer

Example

Hierarchy (View Summary)

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns ShieldRenderer

Methods

createGraphics

Parameters

Returns CanvasRenderingContext2D

debugOptions

Parameters

Returns AbstractShieldRenderer

emptySprite

Returns CanvasRenderingContext2D

filterImageID

Parameters

Returns AbstractShieldRenderer

filterNetwork

Parameters

Returns AbstractShieldRenderer

getGraphicForRoute

Parameters

Returns CanvasRenderingContext2D

getShieldDefinitions

Returns ShieldDefinitions

getStyleImageMissingHandler

Returns (e: MapStyleImageMissingEvent) => void

graphicsFactory

Parameters

Returns AbstractShieldRenderer

onShieldDefLoad

Parameters

Returns AbstractShieldRenderer

pixelRatio

Returns number

renderOnMaplibreGL

Parameters

Returns AbstractShieldRenderer

renderOnRepository

Parameters

Returns AbstractShieldRenderer

ProtectedsetShields

Parameters

Returns void

Settings

On This Page

`Protected`setShields