Class LayerPreset

A LayerPreset that can be applied to a map or a map extension.

Hierarchy (view full)

EntityBase<LayerPresetProperties>
- LayerPreset

Constructors

constructor

new LayerPreset(properties?): LayerPreset
Creates a new instance of the entity and assigns the given properties.
Parameters
- Optionalproperties: LayerPresetProperties
  The properties to set via assignProperties().
Returns LayerPreset
Inherited from EntityBase.constructor

Properties

`Protected` `Readonly`_handles

_handles: Handles<unknown, ResourceHandle>

`Protected`_id

_id: string

The unique ID for this entity. Once set, this should never change.

`Protected` `Readonly`_itemType

_itemType: string = ItemType.LAYER_PRESET

The item type for this entity when it participates in an App.

@eventTypes

@eventTypes: InitializableBaseEvents

Deprecated

Do not directly reference this property. Use EventNames and EventTypes helpers from @arcgis/core/Evented.

basemap

basemap: WellKnownBasemap | BasemapProperties

Current basemap of a map.

basemapOptions

basemapOptions: (WellKnownBasemap | BasemapProperties)[]

Available basemap options of a map.

description

description: string

A human readable description of the LayerPreset.

icon

icon: string

An optional icon that can be displayed when listing the LayerPreset.

iconUrl

iconUrl: string

An optional url to an image that can be displayed when listing the LayerPreset.

layers

layers: Map<string | LayerReference | SublayerReference, LayerPresetSetting>

LayerPresetSettings that can be applied to the layers of a map.

title

title: string

A human readable title for the LayerPreset.

Accessors

failureMode

get failureMode(): FailureMode
Determines how a parent object should handle initialization failure in this object. The default is "warn".
- "error": support/InitializeError!InitializeError is thrown.
- "warn": Message is logged and support/InitializableBase!InitializeWarningEvent is raised.
- "ignore": support/InitializableBase!InitializeWarningEvent is raised.
Returns FailureMode
Inherited from EntityBase.failureMode
set failureMode(value): void
Parameters
- value: FailureMode
Returns void
Inherited from EntityBase.failureMode

id

get id(): string
The unique ID for this entity.

Returns string
Inherited from EntityBase.id

isDestroyed

get isDestroyed(): boolean
See support/InitializableBase!Initializable.isDestroyed.

Returns boolean
Inherited from EntityBase.isDestroyed

isInitialized

get isInitialized(): boolean
See support/InitializableBase!Initializable.isInitialized.

Returns boolean
Inherited from EntityBase.isInitialized

itemType

get itemType(): string
The item type for this entity when it participates in an App.

Returns string
Inherited from EntityBase.itemType

Methods

`Protected`_getSerializableProperties

_getSerializableProperties(): PropertyDefs<LayerPresetProperties>
The property keys and their metadata that are used to implement serializing and deserializing the class instance.

Returns PropertyDefs<LayerPresetProperties>
Overrides EntityBase._getSerializableProperties

`Protected`_initializableChildCollections

_initializableChildCollections(): IterableIterator<Collection<InitializableBase<InitializableBaseProperties>>, any, any>
Collections of child items to initialize. Items that fail to initialize are removed from the collection.

Returns IterableIterator<Collection<InitializableBase<InitializableBaseProperties>>, any, any>
Inherited from EntityBase._initializableChildCollections

`Protected`_initializeChildren

_initializeChildren(): Promise<void>
Initializes child entities.

Returns Promise<void>
Inherited from EntityBase._initializeChildren

`Protected`_onDestroy

_onDestroy(): Promise<void>
Called to perform cleanup. Subclasses should override this method rather than destroy() to perform custom cleanup.

Returns Promise<void>
Inherited from EntityBase._onDestroy

`Protected`_onInitialize

_onInitialize(): Promise<void>
Called to perform initialization of the support/InitializableBase!InitializableBase. Subclasses should override this method rather than initialize() to perform custom initialization.

Returns Promise<void>
Inherited from EntityBase._onInitialize

`Protected`_postInitialize

_postInitialize(): Promise<void>
Called after normal initialization. Note: Child items are initialized before this is called.

Returns Promise<void>
Inherited from EntityBase._postInitialize

`Protected`_toPropertyDef

_toPropertyDef<T>(def): PropertyDef<T>
Converts the value to a PropertyDef object.
Type Parameters
- T
Parameters
- def: PropertyDefSerializeMode | PropertyDefSerializeMode[] | PropertyDef<T>
  The value to convert.
Returns PropertyDef<T>
Inherited from EntityBase._toPropertyDef

applyTo

applyTo(mapOrExtension): Promise<void>
Applies this LayerPreset to a map extension or a collection of map extensions.
Parameters
- mapOrExtension:
      | Map
      | MapExtension
      | Iterable<Map, any, any>
      | Iterable<MapExtension, any, any>
  The map extension or collection of map extensions to apply the LayerPreset to.
Returns Promise<void>

assignProperties

assignProperties(properties): void
Parameters
- properties: Partial<LayerPresetProperties>
Returns void
Inherit Doc
Inherited from EntityBase.assignProperties

assignPropertiesAsync

assignPropertiesAsync(properties): Promise<void>
Parameters
- properties: Partial<LayerPresetProperties>
Returns Promise<void>
Inherit Doc
Inherited from EntityBase.assignPropertiesAsync

destroy

destroy(): Promise<void>
A clean-up function that should get called whenever the item is disposed of.

Returns Promise<void>
Inherited from EntityBase.destroy

finishAssignProperties

finishAssignProperties(): Promise<void>
Returns Promise<void>
Inherit Doc
Inherited from EntityBase.finishAssignProperties

getDefault

getDefault<K>(key): LayerPresetProperties[K]
Type Parameters
- K extends keyof LayerPresetProperties
Parameters
- key: K
Returns LayerPresetProperties[K]
Inherit Doc
Inherited from EntityBase.getDefault

getDefaults

getDefaults(): LayerPresetProperties
Returns LayerPresetProperties
Inherit Doc
Inherited from EntityBase.getDefaults

getSerializableProperties

getSerializableProperties(serializeMode?): PropertyDefs<LayerPresetProperties>
Returns the serializable properties.
Parameters
- OptionalserializeMode: SerializeMode
  Optional. If specified, only properties that support the given serialization mode will be returned.
Returns PropertyDefs<LayerPresetProperties>
Inherited from EntityBase.getSerializableProperties

initialize

initialize(): Promise<void>
Initializes the item.

Returns Promise<void>
Inherited from EntityBase.initialize

toItemUri

toItemUri(): string
Creates an item:// URI reference to this entity.

Returns string
Inherited from EntityBase.toItemUri

toJSON

toJSON(serializeMode?): LayerPresetProperties
Parameters
- serializeMode: SerializeMode = "all"
Returns LayerPresetProperties
Inherit Doc
Inherited from EntityBase.toJSON

`Static`createFrom

createFrom(mapOrExtension): LayerPreset
Creates a LayerPreset from an ESRI map or map extension.
Parameters
- mapOrExtension: Map | MapExtension
  The map or map extension to create a LayerPreset from.
Returns LayerPreset

Class LayerPreset

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns LayerPreset

Properties

Protected Readonly_handles

Protected_id

Protected Readonly_itemType

@eventTypes

Deprecated

basemap

basemapOptions

description

icon

iconUrl

layers

title

Accessors

failureMode

Returns FailureMode

Parameters

Returns void

id

Returns string

isDestroyed

Returns boolean

isInitialized

Returns boolean

itemType

Returns string

Methods

Protected_getSerializableProperties

Returns PropertyDefs<LayerPresetProperties>

Protected_initializableChildCollections

Returns IterableIterator<Collection<InitializableBase<InitializableBaseProperties>>, any, any>

Protected_initializeChildren

Returns Promise<void>

Protected_onDestroy

Returns Promise<void>

Protected_onInitialize

Returns Promise<void>

Protected_postInitialize

Returns Promise<void>

Protected_toPropertyDef

Type Parameters

Parameters

Returns PropertyDef<T>

applyTo

Parameters

Returns Promise<void>

assignProperties

Parameters

Returns void

Inherit Doc

assignPropertiesAsync

Parameters

Returns Promise<void>

Inherit Doc

destroy

Returns Promise<void>

finishAssignProperties

Returns Promise<void>

Inherit Doc

getDefault

Type Parameters

Parameters

Returns LayerPresetProperties[K]

Inherit Doc

getDefaults

Returns LayerPresetProperties

Inherit Doc

getSerializableProperties

Parameters

`Protected` `Readonly`_handles

`Protected`_id

`Protected` `Readonly`_itemType

`Protected`_getSerializableProperties

`Protected`_initializableChildCollections

`Protected`_initializeChildren

`Protected`_onDestroy

`Protected`_onInitialize

`Protected`_postInitialize

`Protected`_toPropertyDef

`Static`createFrom