import "@arcgis/map-components/components/arcgis-version-management";
The Version Management Component allows users to view available versions, change versions, delete versions, and alter versions. The View will update to match the features on the selected version. To learn more about version management please visit the versioning guide doc.
The VersionManagement Component does not support proxied feature services or feature services that utilize stored credentials.
Note: Sign in to access the data in this sample, U/P: viewer01
/I68VGU^nMurF
Demo
Properties
Property | Attribute | Type |
---|---|---|
allow-editing-disabled | boolean | |
auto-destroy-disabled | boolean | |
closable | boolean | |
icon | string | |
| Array<{
url: string;
name: string;
}> | |
label | string | |
| {
label?: string | undefined;
actions?: {
cancelSave?: string | undefined;
deleteVersion?: string | undefined;
editVersion?: string | undefined;
newVersion?: string | undefined;
refreshVersions?: string | undefined;
saveVersion?: string | undefined;
searchVersions?: string | undefined;
switchToVersion?: string | undefined;
} | undefined;
accessLevels?: {
private?: string | undefined;
protected?: string | undefined;
public?: string | undefined;
} | undefined;
executionErrors?: {
invalidVersionName?: string | undefined;
noAdvancedEditingUserTypeExtension?: string | undefined;
noFeatureServiceFound?: string | undefined;
notValidEnterpriseVersion?: string | undefined;
noVersionManagementServiceFound?: string | undefined;
} | undefined;
headers?: {
currentVersion?: string | undefined;
manageVersions?: string | undefined;
filterVersions?: string | undefined;
versionProperties?: string | undefined;
invalidInitialVersion?: string | undefined;
invalidInitialFeatureService?: string | undefined;
} | undefined;
input?: {
versionAccess?: string | undefined;
versionDescription?: string | undefined;
versionName?: string | undefined;
versionOwner?: string | undefined;
} | undefined;
loadErrors?: {
invalidInitialVersion?: string | undefined;
invalidInitialFeatureService?: string | undefined;
noFeatureServices?: string | undefined;
noViewProperty?: string | undefined;
} | undefined;
} | |
mode | string | |
page-size | number | |
position | "bottom-leading" | "bottom-left" | "bottom-right" | "bottom-trailing" | "manual" | "top-leading" | "top-left" | "top-right" | "top-trailing" | |
reference-element | ArcgisLinkChart | ArcgisMap | ArcgisScene | string | |
state readonly | state | "disabled" | "executing" | "failed" | "loading" | "ready" | "success" |
| ||
|
allowEditingDisabled
allowEditingDisabled: boolean
- Attribute
- allow-editing-disabled
- Default value
- false
autoDestroyDisabled
autoDestroyDisabled: boolean
If true, the component will not be destroyed automatically when it is disconnected from the document. This is useful when you want to move the component to a different place on the page, or temporarily hide it. If this is set, make sure to call the `destroy` method when you are done to prevent memory leaks.
- Attribute
- auto-destroy-disabled
- Default value
- false
initialVersionInfos
initialVersionInfos: Array<{
url: string;
name: string;
}>
The initialVersionInfos
property enables users to initialize the Version Management Component with a predefined set of versions.
By providing an array of InitialVersionInfo
, the component displays a specified version for each feature service upon initialization.
messageOverrides
messageOverrides: {
label?: string | undefined;
actions?: {
cancelSave?: string | undefined;
deleteVersion?: string | undefined;
editVersion?: string | undefined;
newVersion?: string | undefined;
refreshVersions?: string | undefined;
saveVersion?: string | undefined;
searchVersions?: string | undefined;
switchToVersion?: string | undefined;
} | undefined;
accessLevels?: {
private?: string | undefined;
protected?: string | undefined;
public?: string | undefined;
} | undefined;
executionErrors?: {
invalidVersionName?: string | undefined;
noAdvancedEditingUserTypeExtension?: string | undefined;
noFeatureServiceFound?: string | undefined;
notValidEnterpriseVersion?: string | undefined;
noVersionManagementServiceFound?: string | undefined;
} | undefined;
headers?: {
currentVersion?: string | undefined;
manageVersions?: string | undefined;
filterVersions?: string | undefined;
versionProperties?: string | undefined;
invalidInitialVersion?: string | undefined;
invalidInitialFeatureService?: string | undefined;
} | undefined;
input?: {
versionAccess?: string | undefined;
versionDescription?: string | undefined;
versionName?: string | undefined;
versionOwner?: string | undefined;
} | undefined;
loadErrors?: {
invalidInitialVersion?: string | undefined;
invalidInitialFeatureService?: string | undefined;
noFeatureServices?: string | undefined;
noViewProperty?: string | undefined;
} | undefined;
}
Replace localized message strings with your own strings.
pageSize
pageSize: number
Specifies the number of versions displayed on each page of the Version Management Component.
- Attribute
- page-size
- Default value
- 5
position
position: "bottom-leading" | "bottom-left" | "bottom-right" | "bottom-trailing" | "manual" | "top-leading" | "top-left" | "top-right" | "top-trailing"
- Attribute
- position
- Default value
- "top-right"
referenceElement
referenceElement: ArcgisLinkChart | ArcgisMap | ArcgisScene | string
- Attribute
- reference-element
state
state: "disabled" | "executing" | "failed" | "loading" | "ready" | "success"
The viewModel's state.
- Attribute
- state
versioningStates
versioningStates: Collection<VersioningState>
This class provides functionality for managing versions in a versioned geodatabase.
In the event that the Version Management component is destroyed, the VersioningStates can be utilized to maintain the current state of the Version Management Component.
The Version Management Component can be reinitialized using a Collection<VersioningState>
, or a predefined Collection<VersioningState>
can be provided during the initial instantiation of the Version Management Component.
Methods
Method | Signature |
---|---|
componentOnReady(): Promise<void> | |
destroy(): Promise<void> |
componentOnReady
componentOnReady(): Promise<void>
Create a promise that resolves once component is fully loaded.
- Returns
- Promise<void>
Events
Event | Type |
---|---|
undefined | |
VersioningStateEvent |