Class Basemap

constructor

• new Basemap(rampConfig): Basemap

• This constructor should not be called directly, as it will not populate the underlying ESRI basemap. Use static method Basemap.create(rampConfig)

  Parameters

  • rampConfig: RampBasemapConfig

  Returns Basemap

Readonlyconfig

createErr

esriBasemap

altText

• get altText(): undefined | string

• Get this basemap's alt text from the config

  Returns undefined | string
• set altText(value): void

• Set this basemap's alt text

  Parameters

  • value: undefined | string

  Returns void

attribution

• get attribution(): undefined | Attribution

• Get this basemap's attribution config

  Returns undefined | Attribution
• set attribution(value): void

• Set this basemap's attribution

  Parameters

  • value: undefined | Attribution

  Returns void

backgroundColour

• get backgroundColour(): string

• Get this basemap's background colour

  Returns string

description

• get description(): undefined | string

• Get this basemap's description from the config

  Returns undefined | string
• set description(value): void

• Set this basemap's description

  Parameters

  • value: undefined | string

  Returns void

id

• get id(): string

• Returns the basemap id from the config

  Returns string

name

• get name(): undefined | string

• Get this basemap's name from the config

  Returns undefined | string
• set name(value): void

• Set this basemap's name

  Parameters

  • value: undefined | string

  Returns void

tileSchemaId

• get tileSchemaId(): string

• Returns the tile schema id from the config

  Returns string

Staticcreate

• create(rampConfig): Promise<Basemap>

• Will generate a populated basemap

  Parameters

  • rampConfig: RampBasemapConfig

    configuration object for the basemap

  Returns Promise<Basemap>

  resolves with generated basemap