Skip to content

Commit

Permalink
Change Gecortex -> VertiGIS Studio (#96)
Browse files Browse the repository at this point in the history
Change user facing Gecortex -> VertiGIS Studio
  • Loading branch information
Conner Leverett authored Jan 26, 2022
1 parent 118e58b commit c5b9a74
Show file tree
Hide file tree
Showing 162 changed files with 844 additions and 856 deletions.
14 changes: 7 additions & 7 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ New pages can be added under each product within the `docs` folder (`docs/web`,
```
---
title: Overview
description: Geocortex Web - Overview
description: VertiGIS Studio Web - Overview
---
```

Expand Down Expand Up @@ -127,11 +127,11 @@ You can bring emphasis to certain lines of code by specifying line ranges after

The following guidelines apply to adding screenshots of the products, usually for example or demo purposes. All other images will be treated on a case by case basis, but should still be processed through [Tiny PNG](https://tinypng.com/).

#### Geocortex Web
#### VertiGIS Studio Web

Geocortex Web screenshots should be taken at a certain window size for consistency. This can be easily achieved using the chrome developer tools.
VertiGIS Studio Web screenshots should be taken at a certain window size for consistency. This can be easily achieved using the chrome developer tools.

1. Open the Geocortex Web page you want to screenshot.
1. Open the VertiGIS Studio Web page you want to screenshot.
2. Open the dev tools.
3. Go to settings / devices
4. [Add a custom device](https://developers.google.com/web/tools/chrome-devtools/device-mode#custom) with the following settings:
Expand All @@ -156,11 +156,11 @@ Geocortex Web screenshots should be taken at a certain window size for consisten
<img src={useBaseUrl("img/layout-multi-component-config.png")}/>
```

#### Geocortex Mobile
#### VertiGIS Studio Mobile

Geocortex Mobile screenshots should be roughly taken with a certain window size for consistency.
VertiGIS Studio Mobile screenshots should be roughly taken with a certain window size for consistency.

1. Open the Geocortex Mobile application you want to screenshot.
1. Open the VertiGIS Studio Mobile application you want to screenshot.
- Unless demonstrating theming functionality, all screenshots should be taken with the dark theme.
2. Using the `Windows + Left` then `Windows + Up` shortcuts to move the app window to occupy a corner of the screen.
3. Using Windows [snipping tool](https://support.microsoft.com/en-ca/help/13776/windows-10-use-snipping-tool-to-capture-screenshots), capture a window screenshot of the application.
Expand Down
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2020 VertiGIS North America Ltd.
Copyright (c) 2022 VertiGIS North America Ltd.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Geocortex Developer Center
# VertiGIS Studio Developer Center

![CI/CD](https://github.com/geocortex/dev-center/workflows/CI/CD/badge.svg)

This is the source for the [Geocortex Developer Center](https://developers.geocortex.com) website; feel free to suggest changes to our docs!
This is the source for the [VertiGIS Studio Developer Center](https://developers.geocortex.com) website; feel free to suggest changes to our docs!

## Contributing

Expand Down
67 changes: 36 additions & 31 deletions blog/2021-03-22-new-workflow-element-api.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,12 @@ tags: [workflow]

import Link from "@docusaurus/Link";

Workflow `5.21` includes a new TypeScript form element API that you can use for building custom form elements using the <Link to="/docs/workflow/sdk-web-overview">Geocortex Workflow TypeScript SDK</Link>. The existing patterns and APIs you've been using for years to build custom form elements will continue to work, but we encourage you to try the new API when building new form elements.
Workflow `5.21` includes a new TypeScript form element API that you can use for building custom form elements using the <Link to="/docs/workflow/sdk-web-overview">VertiGIS Studio Workflow TypeScript SDK</Link>. The existing patterns and APIs you've been using for years to build custom form elements will continue to work, but we encourage you to try the new API when building new form elements.

<!--truncate-->

:::note
To use these new features, you will need the latest version of Geocortex Workflow, as well as the Geocortex Workflow SDK.
To use these new features, you will need the latest version of VertiGIS Studio Workflow, as well as the VertiGIS Studio Workflow SDK.
:::

The new form element API provides a number of new features and benefits:
Expand Down Expand Up @@ -115,10 +115,11 @@ This added some extra boilerplate that we felt was unnecessary. More importantly
When registering your element using the new API and the latest version of the Workflow SDK, it is no longer necessary to run the activity prior to _Display Form_:
```ts
const DemoElementRegistration: FormElementRegistration<DemoElementProps> = {
component: DemoElement,
id: "Demo",
};
const DemoElementRegistration: FormElementRegistration<DemoElementProps> =
{
component: DemoElement,
id: "Demo",
};

export default DemoElementRegistration;
```
Expand Down Expand Up @@ -374,32 +375,36 @@ function RangeSlider(props: RangeSliderProps): React.ReactElement {
);
}

const RangeSliderElementRegistration: FormElementRegistration<RangeSliderProps> = {
component: RangeSlider,
getInitialProperties: () => ({
max: 100,
min: 0,
step: 5,
value: 50,
}),
id: "RangeSlider",
onPropertyChange: ({ properties, property }) => {
if (
property === "max" ||
property === "min" ||
property === "step" ||
property === "value"
) {
const value = properties[property];

// Ensure we always have the type we expect assigned to the element
// properties.
if (typeof value !== "number" || Number.isNaN(value)) {
throw new Error("Unexpected type");
const RangeSliderElementRegistration: FormElementRegistration<RangeSliderProps> =
{
component: RangeSlider,
getInitialProperties: () => ({
max: 100,
min: 0,
step: 5,
value: 50,
}),
id: "RangeSlider",
onPropertyChange: ({ properties, property }) => {
if (
property === "max" ||
property === "min" ||
property === "step" ||
property === "value"
) {
const value = properties[property];

// Ensure we always have the type we expect assigned to the element
// properties.
if (
typeof value !== "number" ||
Number.isNaN(value)
) {
throw new Error("Unexpected type");
}
}
}
},
};
},
};

export default RangeSliderElementRegistration;
```
4 changes: 2 additions & 2 deletions docs/mobile/api-commands-operations-events.mdx
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
---
title: Commands, Operations and Events Reference
description: Geocortex Mobile - Commands, Operations and Events API Reference
description: VertiGIS Studio Mobile - Commands, Operations and Events API Reference
---

import ViewerMessaging from "../../src/components/ViewerMessaging";

Commands and operations are runnable, independent units of work within Geocortex Mobile. [Commands](#commands) are units of work which may take an input but do not produce an output, while [operations](#operations) differ because they produce output. You can learn more about commands and operations in our [conceptual documentation](configuration-commands-operations.mdx)
Commands and operations are runnable, independent units of work within VertiGIS Studio Mobile. [Commands](#commands) are units of work which may take an input but do not produce an output, while [operations](#operations) differ because they produce output. You can learn more about commands and operations in our [conceptual documentation](configuration-commands-operations.mdx)

[Events](#events) are distinct, discrete messaging about a change or update that occurs in the viewer. They can be used to initiate behaviors, communicate data changes, and more. Events themselves do not execute behavior, but merely provide messaging so subscribers can act on changes. You can learn more about events in the [event reference](sdk-events-reference.mdx)

Expand Down
2 changes: 1 addition & 1 deletion docs/mobile/api-components.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Components and Services
description: Geocortex Mobile - Component and service configuration
description: VertiGIS Studio Mobile - Component and service configuration
---

import ViewerMessaging from "../../src/components/ViewerMessaging";
Expand Down
2 changes: 1 addition & 1 deletion docs/mobile/configuration-advanced-model-binding.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Advanced Model Binding
description: Geocortex Mobile - Learn about advanced model binding with layout
description: VertiGIS Studio Mobile - Learn about advanced model binding with layout
---

The scale bar component displays information about a particular map. More specifically, it is **dependent** on the data of a map model to display its values.
Expand Down
6 changes: 3 additions & 3 deletions docs/mobile/configuration-app-config-getting-started.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: App Config
sidebar_label: Getting Started
description: Geocortex Mobile - Learn about Geocortex Mobile's configuration concepts
description: VertiGIS Studio Mobile - Learn about VertiGIS Studio Mobile's configuration concepts
---

import useBaseUrl from "@docusaurus/useBaseUrl";
Expand Down Expand Up @@ -35,7 +35,7 @@ Every component within the viewer that requires functional, compositional conten
Every component in the layout can be linked to app config with the `config` attribute. The `config` attribute is used to identify the item in the app config that has configuration for the component.

:::note
If you do not provide a `config` attribute for a component, Geocortex Mobile will attempt to [infer a default value](sdk-components-reference.mdx#component-defaults).
If you do not provide a `config` attribute for a component, VertiGIS Studio Mobile will attempt to [infer a default value](sdk-components-reference.mdx#component-defaults).
:::

<Tabs
Expand Down Expand Up @@ -270,7 +270,7 @@ The functionality of the `config` attribute is dependent on the fact that IDs ac

## Relevant SDK Samples

The Geocortex Mobile SDK Samples project has a variety of app configuration samples:
The VertiGIS Studio Mobile SDK Samples project has a variety of app configuration samples:

- [App Configuration Samples](https://github.com/geocortex/vertigis-mobile-samples/tree/master/Geocortex.Mobile.Samples/Geocortex.Mobile.Samples/Samples/AppConfiguration)

Expand Down
8 changes: 4 additions & 4 deletions docs/mobile/configuration-app-config-reference.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: App Config Reference
description: Geocortex Mobile - App config reference
description: VertiGIS Studio Mobile - App config reference
---

import AppItemSnippet from "../snippets/app-item.mdx";
Expand Down Expand Up @@ -29,15 +29,15 @@ The `$schema` property powers the Visual Studio intellisense in the `app.json` f
The `ViewerFramework` folder containing the schema will not be created until an initial build is complete.
:::

The `schemaVersion` property is a required property that informs Geocortex Mobile what version of app config you are using. This allows for the schema to be updated in future releases without breaking old configuration.
The `schemaVersion` property is a required property that informs VertiGIS Studio Mobile what version of app config you are using. This allows for the schema to be updated in future releases without breaking old configuration.

## App Items

<AppItemSnippet />

### Custom App Items

App items in Geocortex Mobile correspond to a class that extends `VisualAppItem` and registers with **Autofac** as an [`AppItem` type](sdk-dependency-injection.mdx#appitem), like the `CustomComponentConfiguration` in the [app config tutorial](tutorial-implement-component-participate-app-config.mdx#create-a-skeleton-app-config-definition).
App items in VertiGIS Studio Mobile correspond to a class that extends `VisualAppItem` and registers with **Autofac** as an [`AppItem` type](sdk-dependency-injection.mdx#appitem), like the `CustomComponentConfiguration` in the [app config tutorial](tutorial-implement-component-participate-app-config.mdx#create-a-skeleton-app-config-definition).

<AutofacSnippet />

Expand Down Expand Up @@ -83,7 +83,7 @@ These item URIs can be used by app items to include other app items as property
}
```

**Resource URIs** are used to load layouts in Geocortex Mobile. Layout files are [added to Geocortex Mobile](tutorial-add-medium-layout.mdx) as an asset which is copied into the end users local data folder. These copied assets are referenced with a URI of the format
**Resource URIs** are used to load layouts in VertiGIS Studio Mobile. Layout files are [added to VertiGIS Studio Mobile](tutorial-add-medium-layout.mdx) as an asset which is copied into the end users local data folder. These copied assets are referenced with a URI of the format

`resource://layout-<size>.xml`

Expand Down
20 changes: 10 additions & 10 deletions docs/mobile/configuration-commands-operations.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Commands and Operations
description: Geocortex Mobile - Learn about commands and operations
description: VertiGIS Studio Mobile - Learn about commands and operations
---

import useBaseUrl from "@docusaurus/useBaseUrl";
Expand All @@ -14,10 +14,10 @@ import UseCaseContainer from "../../src/components/UseCaseContainer";
Check out the [Key Concepts](key-concepts.mdx).
:::

**Commands and operations** are runnable, independent units of work within Geocortex Mobile. Commands and operations act as global functions which can be
**Commands and operations** are runnable, independent units of work within VertiGIS Studio Mobile. Commands and operations act as global functions which can be
executed from any component or service.

In Geocortex Mobile, commands and operations are compatible extensions of the [ICommand interface](https://docs.microsoft.com/en-us/windows/uwp/design/controls-and-patterns/commanding) with strongly typed arguments and return values. Operations are implementations of `ICommand` that have been extended to have an `ExecuteAsync` method, which allows the operation to run asynchronously and return a value. Commands and Operations are registered with the globally available service `IOperationRegistry`, in which they can be looked up by their `name`. Commands and Operations are grouped by namespaces, such as `auth` or `edit`.
In VertiGIS Studio Mobile, commands and operations are compatible extensions of the [ICommand interface](https://docs.microsoft.com/en-us/windows/uwp/design/controls-and-patterns/commanding) with strongly typed arguments and return values. Operations are implementations of `ICommand` that have been extended to have an `ExecuteAsync` method, which allows the operation to run asynchronously and return a value. Commands and Operations are registered with the globally available service `IOperationRegistry`, in which they can be looked up by their `name`. Commands and Operations are grouped by namespaces, such as `auth` or `edit`.

```
auth.sign-in
Expand All @@ -27,10 +27,10 @@ edit.delete-features
```

:::tip
The full list of existing commands and operations available in Geocortex Mobile can be [found in the API documentation](api-commands-operations-events.mdx).
The full list of existing commands and operations available in VertiGIS Studio Mobile can be [found in the API documentation](api-commands-operations-events.mdx).
:::

Commands and operations are used to power much of Geocortex Mobile's built in behavior and interactions. They can be run through configuration, or through [custom services](sdk-commands-operations.mdx) or [components](sdk-commands-operations.mdx).
Commands and operations are used to power much of VertiGIS Studio Mobile's built in behavior and interactions. They can be run through configuration, or through [custom services](sdk-commands-operations.mdx) or [components](sdk-commands-operations.mdx).

One thing that makes commands and operations so powerful is that built in components have properties in the app config which take them as values. They power everything from basic components like the IWTM, to advanced functionality like the results list. This allows built-in component's internal behavior to be configured with different commands and operations.

Expand Down Expand Up @@ -84,7 +84,7 @@ One thing that makes commands and operations so powerful is that built in compon

## Workflow Command

[Geocortex Workflow](https://docs.geocortex.com/workflow/) can allow for the creation of completely customized behavior without writing custom code. Geocortex Mobile has a special command, `workflow.run`, which allows you to run workflows anywhere you would run a command or operation. Using workflow, you can take custom behavior in Geocortex Mobile further without having to write custom code.
[VertiGIS Studio Workflow](https://docs.geocortex.com/workflow/) can allow for the creation of completely customized behavior without writing custom code. VertiGIS Studio Mobile has a special command, `workflow.run`, which allows you to run workflows anywhere you would run a command or operation. Using workflow, you can take custom behavior in VertiGIS Studio Mobile further without having to write custom code.

Check out this example of [running a workflow from app config](tutorial-run-workflow-app-config.mdx).

Expand Down Expand Up @@ -333,15 +333,15 @@ The second command/operation in this application is a `map.zoom-to-initial-viewp

## Relevant SDK Samples

Check out the relevant Geocortex Mobile SDK Samples:
Check out the relevant VertiGIS Studio Mobile SDK Samples:

- [Commands](https://github.com/geocortex/vertigis-mobile-samples/tree/master/Geocortex.Mobile.Samples/Geocortex.Mobile.Samples/Samples/AppConfiguration/Commands)

- [Map and Feature Commands](https://github.com/geocortex/vertigis-mobile-samples/tree/master/Geocortex.Mobile.Samples/Geocortex.Mobile.Samples/Samples/AppConfiguration/MapAndFeatureCommands)

## Next Steps

Geocortex Mobile has a large array of built-in command and operations that you can chain to power custom behavior. Custom commands and operations can also be implemented with the SDK.
VertiGIS Studio Mobile has a large array of built-in command and operations that you can chain to power custom behavior. Custom commands and operations can also be implemented with the SDK.

<UseCaseContainer>
<UseCaseCard
Expand All @@ -366,8 +366,8 @@ Geocortex Mobile has a large array of built-in command and operations that you c
)}
/>
<UseCaseCard
title="Learn about Events built into Geocortex Mobile"
description="Learn about the global event infrastructure in Geocortex Mobile"
title="Learn about Events built into VertiGIS Studio Mobile"
description="Learn about the global event infrastructure in VertiGIS Studio Mobile"
link={useBaseUrl("docs/mobile/sdk-events-reference")}
/>
</UseCaseContainer>
Loading

0 comments on commit c5b9a74

Please sign in to comment.