gi-nx

---

gi-nx / createUsage

function createUsage(usageName: string, usageDefinition: Usage): void;

Create a new usage definition in the current project.

createUsage(usageName: string, usageDefinition: Usage): void

Parameters

Parameter	Type	Description
usageName	string	The name for the new usage (e.g. 'Industrial', 'Park').
usageDefinition	Usage	The usage definition. Must contain a default object (property defaults applied to features) and a join object (property join rules).

Returns

void

Throws

Error if a usage with that name already exists. Use updateUsage to modify an existing usage.

Throws

Error if the usage definition is missing default or join objects.

Example

rpc.invoke("createUsage", ["Industrial", {
  default: { height: 15, levels: 3, color: "#888888" },
  join: { floorToFloor: 3.8, sellEfficiency: 0.8, softCost: 150, stroke: "#555555" }
}]);