On this page

Class ReferenceMapStyle

An instance of reference style contains a list of StyleVariants ordered by relevance

Index

Constructors

Methods

addVariant getDefaultVariant getId getName getVariant getVariants hasVariant

Constructors

constructor

new ReferenceMapStyle(name: string, id: string): ReferenceMapStyle
Parameters
- name: string
  Human-friendly name of this reference style
- id: string
  ID of this reference style
Returns ReferenceMapStyle

Methods

addVariant

addVariant(v: MapStyleVariant): void
Add a variant to this reference style
Parameters
- v: MapStyleVariant
Returns void

getDefaultVariant

getDefaultVariant(): MapStyleVariant
Get the defualt variant for this reference style

Returns MapStyleVariant

getId

getId(): string
Get the id of this reference style

Returns string

getName

getName(): string
Get the human-friendly name of this reference style

Returns string

getVariant

getVariant(variantType: string): MapStyleVariant
Get a given variant. If the given type of variant does not exist for this reference style, then the most relevant default variant is returned instead
Parameters
- variantType: string
Returns MapStyleVariant

getVariants

getVariants(): MapStyleVariant[]
Get the list of variants for this reference style

Returns MapStyleVariant[]

hasVariant

hasVariant(variantType: string): boolean
Check if a given variant type exists for this reference style
Parameters
- variantType: string
Returns boolean

Was this helpful?