{"id":44356060,"url":"https://github.com/vertigis/vertigis-reporting-client-js","last_synced_at":"2026-02-11T16:08:42.820Z","repository":{"id":38335448,"uuid":"301176548","full_name":"vertigis/vertigis-reporting-client-js","owner":"vertigis","description":"An easy to use JavaScript API for generating reports using VertiGIS Studio Reporting","archived":false,"fork":false,"pushed_at":"2024-07-12T07:33:52.000Z","size":774,"stargazers_count":1,"open_issues_count":1,"forks_count":1,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-10-29T07:35:52.907Z","etag":null,"topics":["geocortex","javascript","reporting","vertigis"],"latest_commit_sha":null,"homepage":"https://developers.vertigisstudio.com/docs/reporting/sdk-js-overview","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/vertigis.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2020-10-04T16:40:10.000Z","updated_at":"2025-08-18T07:14:36.000Z","dependencies_parsed_at":"2022-08-24T05:10:07.768Z","dependency_job_id":"edfd7280-2bdb-4933-a103-93230f0e59bb","html_url":"https://github.com/vertigis/vertigis-reporting-client-js","commit_stats":{"total_commits":27,"total_committers":7,"mean_commits":3.857142857142857,"dds":0.5555555555555556,"last_synced_commit":"c1b4f3169e9b354b231e0fcaf4d13ca0ae96ea07"},"previous_names":["geocortex/vertigis-reporting-client-js"],"tags_count":13,"template":false,"template_full_name":null,"purl":"pkg:github/vertigis/vertigis-reporting-client-js","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vertigis%2Fvertigis-reporting-client-js","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vertigis%2Fvertigis-reporting-client-js/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vertigis%2Fvertigis-reporting-client-js/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vertigis%2Fvertigis-reporting-client-js/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/vertigis","download_url":"https://codeload.github.com/vertigis/vertigis-reporting-client-js/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vertigis%2Fvertigis-reporting-client-js/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29337198,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-11T16:00:30.228Z","status":"ssl_error","status_checked_at":"2026-02-11T16:00:25.398Z","response_time":97,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["geocortex","javascript","reporting","vertigis"],"created_at":"2026-02-11T16:08:42.046Z","updated_at":"2026-02-11T16:08:42.806Z","avatar_url":"https://github.com/vertigis.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# VertiGIS Studio Reporting Client for JavaScript\n\n![CI/CD](https://github.com/vertigis/vertigis-reporting-client-js/workflows/CI/CD/badge.svg) ![npm](https://img.shields.io/npm/v/@vertigis/reporting-client)\n\nThis library makes it easy to run [VertiGIS Studio Reporting](https://www.vertigisstudio.com/products/vertigis-studio-reporting/) or [VertiGIS Studio Printing](https://www.vertigisstudio.com/products/vertigis-studio-printing/) jobs in the browser.\n\n## Browser Support\n\nThe client supports the latest, stable releases of all major browsers. Internet Explorer 11 is not supported.\n\n## Requirements\n\n-   The latest LTS version of [Node.js](https://nodejs.org/en/download/)\n-   A code editor of your choice. We recommend [Visual Studio Code](https://code.visualstudio.com/)\n\n## Installing the package\n\nThis package is published to [npm](https://www.npmjs.com/package/@vertigis/reporting-client/), and can be installed using `npm`:\n\n```sh\nnpm install @vertigis/reporting-client\n```\n\n## Generating a report\n\nThe client exports a `run` async function that will return a URL to the report upon completion.\n\n```js\nimport { run } from \"@vertigis/reporting-client\";\n\nconst url = await run(\"itemId\", options?);\n```\n\n### Options\n\n| Option         | Type    | Description                                                                                                                                                                       |\n| -------------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| culture        | string  | The culture to use for localization. For example `\"en-US\"`.                                                                                                                       |\n| dpi            | number  | The DPI to use when rendering a map print. Defaults to `96`.                                                                                                                      |\n| format         | string  | The output format of the report. Defaults to `\"pdf\"`.                                                                                                                             |\n| parameters     | object  | An object specifying additional parameters to pass to the job.                                                                                                                    |\n| portalUrl      | string  | The URL of the ArcGIS Portal instance to use. Defaults to ArcGIS Online: `\"https://www.arcgis.com\"`.                                                                              |\n| resultFileName | string  | The name assigned to the output file. It is used as the name of the tab when viewing the result in a browser and as the suggested name when downloading the result.               |\n| token          | string  | The Portal access token to be used to access secured resources. If not provided requests to secured resources will fail.                                                          |\n| usePolling     | boolean | When `true`, check for results by polling the service. When `false`, check for results using WebSockets. It is recommended to use WebSockets where possible. Defaults to `false`. |\n\n## Examples\n\n### Run a report from ArcGIS Online\n\n```js\nconst url = await run(\"itemId\");\n```\n\n### Run a report from ArcGIS Enterprise\n\n```js\nconst url = await run(\"itemId\", {\n    portalUrl: \"https://server.domain.com/portal\",\n});\n```\n\n### Run a report with parameters\n\n```js\nconst url = await run(\"itemId\", {\n    parameters: {\n        Title: \"My Title\",\n        FeatureIds: [1, 2, 3],\n    },\n});\n```\n\nNote: the parameter keys must mach the names of parameters that exist in the report.\n\n### Run a secured report, or a report that accesses secured ArcGIS content\n\n```js\nconst url = await run(\"itemId\", {\n    token: \"eyJhbGciOiJIUzI1Ni...\",\n});\n```\n\n## Documentation\n\nFind [further documentation on the SDK](https://developers.vertigisstudio.com/docs/reporting/sdk-overview/) on the [VertiGIS Studio Developer Center](https://developers.vertigisstudio.com/docs/reporting/overview/).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvertigis%2Fvertigis-reporting-client-js","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvertigis%2Fvertigis-reporting-client-js","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvertigis%2Fvertigis-reporting-client-js/lists"}