Class URLShieldRenderer

A shield renderer configured from a URL containing a JSON specification

Example

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

Hierarchy

AbstractShieldRenderer
- URLShieldRenderer

Index

Constructors

constructor

Methods

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

Constructors

constructor

new URLShieldRenderer(shieldsURL, routeParser): URLShieldRenderer
Parameters
- shieldsURL: URL
  
  URL containing the JSON shield definition
- routeParser: RouteParser
  
  Function that extracts route identification from a sprite string
Returns URLShieldRenderer
Overrides AbstractShieldRenderer.constructor
- Defined in shield_renderer.ts:303

Methods

createGraphics

createGraphics(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:249

debugOptions

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

emptySprite

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

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

filterImageID

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

filterNetwork

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

getGraphicForRoute

getGraphicForRoute(network, ref, name): 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:235

getShieldDefinitions

getShieldDefinitions(): ShieldDefinitions
Get the shield definitions

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

getStyleImageMissingHandler

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

See MapStyleImageMissingEvent for more details.

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

graphicsFactory

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

onShieldDefLoad

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

pixelRatio

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

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

renderOnMaplibreGL

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

renderOnRepository

renderOnRepository(repo): 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:199

`Private` setShieldURL

setShieldURL(shieldsURL): Promise<void>
Set the URL containing the shield specification
Parameters
- shieldsURL: URL
Returns Promise<void>
- Defined in shield_renderer.ts:314

`Protected` setShields

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

Class URLShieldRenderer

Example

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

shieldsURL: URL

routeParser: RouteParser

Returns URLShieldRenderer

Methods

createGraphics

Parameters

bounds: Bounds

Returns CanvasRenderingContext2D

debugOptions

Parameters

debugOptions: DebugOptions

Returns AbstractShieldRenderer

emptySprite

Returns CanvasRenderingContext2D

filterImageID

Parameters

shieldPredicate: StringPredicate

Returns AbstractShieldRenderer

filterNetwork

Parameters

networkPredicate: StringPredicate

Returns AbstractShieldRenderer

getGraphicForRoute

Parameters

network: string

ref: string

name: string

Returns CanvasRenderingContext2D

getShieldDefinitions

Returns ShieldDefinitions

getStyleImageMissingHandler

Returns ((e) => void)

Parameters

e: MapStyleImageMissingEvent

Returns void

graphicsFactory

Parameters

gfxFactory: GraphicsFactory

Returns AbstractShieldRenderer

onShieldDefLoad

Parameters

callback: ((shields) => void)

Parameters

shields: ShieldDefinitions

Returns void

Returns AbstractShieldRenderer

pixelRatio

Returns number

renderOnMaplibreGL

Parameters

map: Map

Returns AbstractShieldRenderer

renderOnRepository

Parameters

repo: SpriteRepository

Returns AbstractShieldRenderer

Private setShieldURL

Parameters

shieldsURL: URL

Returns Promise<void>

Protected setShields

Parameters

shieldSpec: ShieldSpecification

Returns void

Settings

Member Visibility

Theme

On This Page

`Private` setShieldURL

`Protected` setShields