List of changes in Action payloads and Action names - 23.1

Spectrum Spatial Analyst Extensibility Guide

Product type
Software
Portfolio
Locate
Product family
Spectrum
Product
Spectrum > Spatial > Spectrum Spatial Analyst
Version
23.1
Language
English
Product name
Spectrum Spatial Analyst
Title
Spectrum Spatial Analyst Extensibility Guide
Topic type
Reference
Overview
Tips
How Do I
Configuration
First publish date
2007

Actions are used in many areas of NgRx. The list of actions whose payload have changed after upgrading the NgRx Store.

Add Layer

All actions updated in the module are listed below.

Action Name Updated payload
AddSSNamedLayerAction type added { namedLayers: NamedLayerData[], repositoryPaths: string[] }

Annotations

Except removing the new operator, there is no change in action creation.

Databind

All actions updated in the module are listed below.

Action Name Updated payload
DataBindExecuteQueryAction type added {url:string}
DataBindExecuteQueryFailureAction input/payload removed
RemoveDataBindAction input/payload removed
GetAllDataBindListAction input/payload removed
UpdateDataBindListAction type added {databindList: DataBindList}
DatabindResultAction Action added. Populates results from a databind join. Previously only present as an action type string.

Find My Nearest

All actions updated in the module are listed below.

Action Name Updated payload
ClearFmnStateAction Removed input/payload
UpdateFmnStateAction Added FmnState type

Layer Information

All actions updated in the module are listed below.

Action Name Updated payload
ClearFeatureInfoAction removed input/payload
ResetCalloutFeaturesAction removed input/payload

Legend Module

All actions updated in the module are listed below.

Action Name Updated payload
UpdateLegendGroupAction payload changed from any to LegendGroup

Login

All actions updated in the module are listed below.

Action Name Updated payload
GetEditPermissionTableListAction

Before upgrade:

this.store.dispatch(new GetEditPermissionTableListAction(tablesList));

After upgrade:

this.store.dispatch(GetEditPermissionTableListAction());

StoreFeatureEditTemplateMappingsAction

Before upgrade:

this.store.dispatch(new StoreFeatureEditTemplateMappingsAction(payload));

After upgrade:

this.store.dispatch(StoreFeatureEditTemplateMappingsAction({ payload: EditTemplateMappingObject }));

FeatureUpdateAction

Before upgrade:

this.store.dispatch(new FeatureUpdateAction(payload));

After upgrade:

this.store.dispatch(FeatureUpdateAction({ payload: FeatureEditableTableObject}));

Map

All actions updated in the module are listed below.

Action Name Updated payload
RemoveFeatureFromMapAction type added {layerName: string, prefix: string, type?: string}
AddFeatureToMapAction type added { feature: GeometryObject, id: number | string, featureName: string, shouldFeatureBeZoomed: boolean }
HighlightFeaturesAction type added { featuresToHighlight?: string[], annotationsDrawn?: string[], operation?: string }
CloseOverlayAction input/payload removed
MoveCopyRightInformationAction input/payload removed
UpdateLegendAction type added SpatialLegendItem | AnnotationObject | VectorLegendInput
UpdateLabelParamsAction type added { name: string, type: string, updatedLabelSources: LabelSource[] }
UpdateLayersParamsAction type added { name: string, type: string, color?: string, layerList?: string[], params?:Unknown macro: { queryResultMapJson}}
RegisterViewEventAction type added {event: string, callback: Function }
ChangeLayerOpacityAction type added {layerName: string, opacity: number}
ToggleLayerVisibilityAction type added { layerName: string, visible: boolean, type?: string, repositoryPath?: string }
AddLayerAction type added MapLayer | VectorLayerOptions | VectorLayerVariant | RangeThematicOptions
DeleteLayerAction type added { name: string, type?: string }
UpdateLayersStateActionOnDelete input type changed to string
TeleportMapInPrintContainerAction input/payload removed
RefreshLayerAction type added { layerName?: string, layerRepositoryPath:string }
UpdateMapSizeAction input/payload removed
UpdateGoogleMapSizeAction type changed to { gMapHeight: number, gMapWidth: number }
ClearMapStateAction input/payload removed
MapClickedAction type changed to MapBrowserEvent
ClearMultiSelectFeatureGeometryAndData input/payload removed
ClearMeasurementLayerAction input/payload removed
ClearLegendLayersAction input/payload removed

MapProject/MapConfig

All actions related to MapConfig module have been moved to MapProject module. You need to update all Import references related to MapConfig action.

Action Name Updated payload
SaveProjectAction type added { payload?: MapProjectUIState }
OpenMapProjectSettingsAction type added { sName: string };
DataUpload

UpdateDataCompleteAction

type added { payload: UploadDataDetails }

ResetUploadDataAction input/payload removed

Marker Overlay

All actions updated in the module are listed below.

Action Name Updated payload
ShowFmnMarkersAction MarkerInformationFmn type added
StartFeatureHoverAction New Action to turn on Feature Hover stream (now disabled by default)
StopFeatureHoverAction New Action to turn of Feature Hover stream

Print Module

All actions updated in the module are listed below.

Action Name Updated payload
EnablePrintModeAction type of payload changed from { status: true } to (payload: EnableDisablePrintModePayload = new EnableDisablePrintModePayload(true))
EnableDisablePrintModePayload

class EnableDisablePrintModePayload {

status: boolean = false;

constructor(enable: boolean)

{ this.status = enable; }

}

DisablePrintModeAction type changed from public payload = { status: false }; to (payload: EnableDisablePrintModePayload = new EnableDisablePrintModePayload(false))
LoadPrintTemplateConfigAction

type of payload has been changed from { file: string, type: string }) to LoadPrintTemplateConfig

which has been defined as :- interface LoadPrintTemplateConfig { file: string; type: string; }

CustomeAnalystModuleConfig no changes

Query

All actions updated in the Query module are listed below.

Action Name Updated payload
SelectQueryAction

type added { queryName: string } : this.store.dispatch(SelectQueryAction({ queryName: 'MyQuery1'}));

Before upgrade:

this.store.dispatch(new SelectQueryAction(queryName));

After upgrade:

this.store.dispatch(SelectQueryAction({ queryName:legendGroup.name }));

DeleteQueryAction

type added { queryName: string }

Before upgrade:

this.store.dispatch(new DeleteQueryAction(queryName));

After upgrade:

this.store.dispatch(DeleteQueryAction({ queryName: queryName }));

LoadPredefinedFiltersSuccessAction

type added { predefinedFilters:string : string[] }

Before upgrade:

this.store.dispatch(new LoadPredefinedFiltersSuccessAction(predefinedFilters));

After upgrade:

this.store.dispatch(LoadPredefinedFiltersSuccessAction({ predefinedFilters: filters }));

LoadVectorFiltersSuccessAction

type added { predefinedFilters: string[] }

Before upgrade:

this.store.dispatch(new LoadVectorFiltersSuccessAction(predefinedFilters));

After upgrade:

this.store.dispatch(LoadVectorFiltersSuccessAction({ predefinedFilters: filters }));

LoadAdminDefinedQueriesAction

type added { adminQueries: string[] }

Before upgrade:

this.store.dispatch(new LoadAdminDefinedQueriesAction(adminQueries));

After upgrade:

this.store.dispatch(LoadAdminDefinedQueriesAction({ adminQueries: adminQueries }));

SelectQueryFilterAction

type added { filterName: string }

Before upgrade:

this.store.dispatch(new SelectQueryFilterAction(filterName));

After upgrade:

this.store.dispatch(SelectQueryFilterAction({ filterName: filterName }));

ClearQueryStateAction

removed input/payload

Before upgrade:

this.store.dispatch(ClearQueryStateAction({}));

After upgrade:

this.store.dispatch(ClearQueryStateAction());

Resource Selector

All actions updated in the module are listed below.

Action Name Updated payload
UpdateSelectedResourcePath

Before upgrade :

this.store.dispatch(new UpdateSelectedResourcePath(path));

After upgrade : this.store.dispatch(UpdateSelectedResourcePath({resourcePath: path}));

ToggleResourceSelectorVisibility

Before upgrade :

this.store.dispatch(new ToggleResourceSelectorVisibility(true));

After upgrade :

this.store.dispatch(ToggleResourceSelectorVisibility({toggleVisiblity: true}));

ToggleResourceSelectorLoading

Before upgrade :

this.store.dispatch(new ToggleResourceSelectorLoading(true));

After upgrade : this.store.dispatch(ToggleResourceSelectorLoading({toggleLoading: true}));

UpdateResourceListData

Before upgrade :

this.store.dispatch(new UpdateResourceListData(data[]));

After upgrade :

this.store.dispatch(UpdateResourceListData({listViewData: data[]}));;

Spatial Named Resources

All actions updated in the module are listed below.

Action Name Updated payload
SetNamedMapDescriptionAction type changed from object to DescribeNamedMapResponse
SetNamedLayersDescriptionsAction types added LayerDescription | DescriptionError)
SelectVectorTableAction VectorTable type added to optional input
SelectVectorColumnAction optional tableId?: string added
SetNamedTableDescriptionsAction type changed from object to {tableRef: string, data: TableMetadata}
GetNamedTablesDescriptionAction type changed from object to {[name: string]: TableMetadata}

Thematic

All actions updated in the module are listed below.

Action Name Updated payload
GetThemeListAction type added {tableRef: string; column: ThematicColumn;}
CompleteThemeListAction type added string[]
GetGeometriesListAction type added {tableRef: string;}
CreateIndividualThematicAction has been deprecated see CreateThematicAction or RequestThematicLegendAction
RequestThematicLegendAction added. Used to request a legend to be generated
ClearThematicStateAction input/payload removed
ClearThematicLegendAction input/payload removed
CreateThematicLegendAction has been deprecated see CreateThematicAction or RequestThematicLegendAction
CreateThematicAction Used to create a generic Thematic with all known details
CompleteThematicLegendAction type added ThematicLegendData
AddThematicLayerAction type changed to ThematicLayer
GetThematicLegendsAction (ThematicLayer) included in type

User Authorization

All actions updated in the module are listed below.

Action Name Updated payload
ClearUserAuthorizationStateAction input/payload removed
UpdateNamedLayersListInAuthStateAction type added { layerList: string[] }
SetWritableFoldersForUserAction type added { folders: string[] }
UpdateTileServiceProfilesForUserAction type added { tileList: string[] }
UpdateWMSProfilesForUserAction type added { wmsProfiles: string[] }
UpdateNamedTablesListInAuthStateAction type added { namedTableList: string[] }
UpdateNamedMapsListForUserAction type added { namedMapList: string[] }
UpdateNamedTilesListForUserAction type added { namedTileList: string[] }
DescribeWMSProfileAction type added { wmsName: string }
DescribeTileServiceProfileAction type added { tileServiceName: string }

Left Panel Open-Layer map

All actions updated in the module are listed below.

Action Name Updated payload
ClearMultiSelectFeaturesDataInitiatedAction

Before upgrade:

this.store.dispatch(new ClearMultiSelectFeaturesDataInitiatedAction(payload));

After upgrade: this.store.dispatch(ClearMultiSelectFeaturesDataInitiatedAction({inputData: payload}));

ClearMultiSelectFeaturesDataCompletedAction

Before upgrade:

this.store.dispatch(new ClearMultiSelectFeaturesDataCompletedAction(payload));

After upgrade:

this.store.dispatch(ClearMultiSelectFeaturesDataCompletedAction({inputData: payload}));