Class SvgUrlBuilder

Fluent builder class for constructing SVG URLs with method chaining

Example

const url = new SvgUrlBuilder('marker')
  .size(44, 44)
  .pixelRatio(2)
  .colors({ fg: '#d35400', bg: '#ffffff' })
  .text('EWR', { fontSize: 18, textColor: '#d35400' })
  .build();

Index

Constructors

constructor

Methods

size pixelRatio colors tint text overlay grid param build

Constructors

constructor

new SvgUrlBuilder(icon: string, protocol?: string): SvgUrlBuilder
Parameters
- icon: string
- protocol: string = 'svg'
Returns SvgUrlBuilder
- Defined in utils/url-builder.ts:294

Methods

size

size(width: number, height?: number): this
Set width and height
Parameters
- width: number
- Optionalheight: number
Returns this
- Defined in utils/url-builder.ts:301

pixelRatio

pixelRatio(ratio: number): this
Set pixel ratio for HiDPI displays
Parameters
- ratio: number
Returns this
- Defined in utils/url-builder.ts:310

colors

colors(opts: { fg?: string; bg?: string; color?: string }): this
Set foreground and background colors
Parameters
- opts: { fg?: string; bg?: string; color?: string }
Returns this
- Defined in utils/url-builder.ts:318

tint

tint(color: string): this
Apply color tint
Parameters
- color: string
Returns this
- Defined in utils/url-builder.ts:328

text

text(content: string, opts?: Partial<OverlayTextParams>): this
Add text overlay
Parameters
- content: string
- Optionalopts: Partial<OverlayTextParams>
Returns this
- Defined in utils/url-builder.ts:336

overlay

overlay(iconId: string, opts?: Partial<OverlaySvgParams>): this
Add SVG overlay
Parameters
- iconId: string
- Optionalopts: Partial<OverlaySvgParams>
Returns this
- Defined in utils/url-builder.ts:347

grid

grid(iconIds: string[], opts?: Partial<OverlayGridParams>): this
Add icon grid
Parameters
- iconIds: string[]
- Optionalopts: Partial<OverlayGridParams>
Returns this
- Defined in utils/url-builder.ts:358

param

param<
    K extends
        | (keyof BaseSvgParams)
        | (keyof SvgColorParams)
        | (keyof SpriteTintParams)
        | (keyof OverlayTextParams)
        | (keyof OverlaySvgParams)
        | (keyof OverlayGridParams),
>(
    key: K,
    value: SvgUrlParams[K],
): this
Set custom parameter
Type Parameters
- K extends
      | (keyof BaseSvgParams)
      | (keyof SvgColorParams)
      | (keyof SpriteTintParams)
      | (keyof OverlayTextParams)
      | (keyof OverlaySvgParams)
      | (keyof OverlayGridParams)
Parameters
- key: K
- value: SvgUrlParams[K]
Returns this
- Defined in utils/url-builder.ts:369

build

build(): string
Build the final URL

Returns string
- Defined in utils/url-builder.ts:377

Class SvgUrlBuilder

Example

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns SvgUrlBuilder

Methods

size

Parameters

Returns this

pixelRatio

Parameters

Returns this

colors

Parameters

Returns this

tint

Parameters

Returns this

text

Parameters

Returns this

overlay

Parameters

Returns this

grid

Parameters

Returns this

param

Type Parameters

Parameters

Returns this

build

Returns string

Settings

On This Page