Interface MapWidgetFactory

Use the map-widget.MapWidgetFactory service to inject an instance of this interface.

The MapWidgetFactory provides some methods to create the parts of a MapWidget.

interface MapWidgetFactory {
    createMap(options: MapProperties): Map;
    createWidget(options: unknown): MapWidget;
    createWidgetModel(
        options: Partial<MapWidgetModelMembers> & { map: Map },
    ): MapWidgetModel;
}

Index

Methods

createMap createWidget createWidgetModel

Methods

createMap

createMap(options: MapProperties): Map
Creates a @arcgis/core/Map instance.
Parameters
- options: MapProperties
  options of the @arcgis/core/Map constructor.
Returns Map
the new map instance.

See
Map
- Defined in api/MapWidgetFactory.ts:21

createWidget

createWidget(options: unknown): MapWidget
Creates a MapWidget instance.
Parameters
- options: unknown
  options of the MapWidget constructor.
Returns MapWidget
the MapWidget instance.
- Defined in api/MapWidgetFactory.ts:39

createWidgetModel

createWidgetModel(
options: Partial<MapWidgetModelMembers> & { map: Map },
): MapWidgetModel
Creates a MapWidgetModel instance.

Note: in options the map parameter is required and needs to be a @arcgis/core/Map instance.
Parameters
- options: Partial<MapWidgetModelMembers> & { map: Map }
  options of the MapWidgetModel constructor.
Returns MapWidgetModel
the MapWidgetModel instance.
- Defined in api/MapWidgetFactory.ts:31