Class Basemap

constructor

• new Basemap(rampConfig: RampBasemapConfig): 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(): string | undefined

  Get this basemap's alt text from the config

  Returns string | undefined

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

  Set this basemap's alt text

  Parameters

  • value: string | undefined

  Returns void

attribution

• get attribution(): Attribution | undefined

  Get this basemap's attribution config

  Returns Attribution | undefined

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

  Set this basemap's attribution

  Parameters

  • value: Attribution | undefined

  Returns void

backgroundColour

• get backgroundColour(): string

  Get this basemap's background colour

  Returns string

description

• get description(): string | undefined

  Get this basemap's description from the config

  Returns string | undefined

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

  Set this basemap's description

  Parameters

  • value: string | undefined

  Returns void

id

• get id(): string

  Returns the basemap id from the config

  Returns string

name

• get name(): string | undefined

  Get this basemap's name from the config

  Returns string | undefined

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

  Set this basemap's name

  Parameters

  • value: string | undefined

  Returns void

tileSchemaId

• get tileSchemaId(): string

  Returns the tile schema id from the config

  Returns string

Staticcreate

• create(rampConfig: RampBasemapConfig): Promise<Basemap>

  Will generate a populated basemap

  Parameters

  • rampConfig: RampBasemapConfig

    configuration object for the basemap

  Returns Promise<Basemap>

  resolves with generated basemap