@vertigis/viewer-spec
Version:
VertiGIS Viewer Specification
105 lines (90 loc) • 3.4 kB
Markdown
# operation: system.get-sharing-link
Description: Creates a link to share the shallow state of the application, including map position and scale, layer visibility and current basemap. Web only.
Inputs: `None`
Outputs: `string`
# operation: system.read-file
Description: Initiates a file read, using the native browser file input. Web only.
Inputs: `ReadFileArgs`
ReadFileArgs properties:
```json
{
"accept": {
"description": "The accept parameter for the file input. See {@link https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/accept}.",
"type": "string"
},
"attributes": {
"description": "Optional layout XML attributes to be used for the transient UI container."
},
"fileTypeDescription": {
"description": "If present, provides information about what file types are accepted by this dialog, e.g. \"*.jpg, *.gif and *.bmp files accepted\".",
"type": "string"
},
"icon": {
"description": "Optional icon that may be used by the transient UI container.",
"type": "string"
},
"multiple": {
"description": "If present, indicates that the user may choose more than one file.",
"type": "boolean"
},
"parent": {
"description": "The layout ID or ItemRef to target for the command/operation. This component will be the parent of the temporary UI that will be removed after the command/operation completes."
},
"promptMessage": {
"description": "If present, overrides the default message of the dialog that prompts the user for a file.",
"type": "string"
},
"promptTitle": {
"description": "If present, overrides the default title of the dialog that prompts the user for a file.",
"type": "string"
}
}
```
Outputs: `File[]`
# operation: system.read-files
Description: A synonym for `system.read-file` that attaches the output to an args object for use in command chains. Web only.
Inputs: `ReadFileArgs`
ReadFileArgs properties:
```json
{
"accept": {
"description": "The accept parameter for the file input. See {@link https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/accept}.",
"type": "string"
},
"attributes": {
"description": "Optional layout XML attributes to be used for the transient UI container."
},
"fileTypeDescription": {
"description": "If present, provides information about what file types are accepted by this dialog, e.g. \"*.jpg, *.gif and *.bmp files accepted\".",
"type": "string"
},
"icon": {
"description": "Optional icon that may be used by the transient UI container.",
"type": "string"
},
"multiple": {
"description": "If present, indicates that the user may choose more than one file.",
"type": "boolean"
},
"parent": {
"description": "The layout ID or ItemRef to target for the command/operation. This component will be the parent of the temporary UI that will be removed after the command/operation completes."
},
"promptMessage": {
"description": "If present, overrides the default message of the dialog that prompts the user for a file.",
"type": "string"
},
"promptTitle": {
"description": "If present, overrides the default title of the dialog that prompts the user for a file.",
"type": "string"
}
}
```
Outputs: `HasFiles`
# operation: system.read-url
Description: Fetch a file from the specified URL. Web only.
Inputs: `string`
Outputs: `File[]`