> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ploterr.com/llms.txt
> Use this file to discover all available pages before exploring further.

# ProjectOrigin

> The origin point of the project, with an optional survey point.

## Import

```typescript theme={null}
import { ProjectOrigin } from '@opengeometry/floorkit';
```

**Inheritance:** `extends OPElement implements IShape, IPlaceable`

## Constructor

```typescript theme={null}
constructor(config?: Partial<ProjectOriginOptions>);
```

<ParamField path="config.datumType" type="DatumType.PROJECT_ORIGIN" />

<ParamField path="config.position" type="[number, number, number]">
  World-space location of the project zero.
</ParamField>

<ParamField path="config.rotationY" type="number">
  Rotation about world Y (radians) applied to the site axes.
</ParamField>

<ParamField path="config.gizmoSize" type="number">
  Arm length of the tri-axis gizmo.
</ParamField>

<ParamField path="config.surveyPoint" type="SurveyPoint">
  Optional survey fix that this origin maps to.
</ParamField>

<ParamField path="config.showBenchmark" type="boolean">
  Whether the triangular benchmark symbol is shown.
</ParamField>

<ParamField path="config.ogid" type="string" />

<ParamField path="config.labelName" type="string" />

<ParamField path="config.color" type="number">
  Line / symbol colour. Defaulted per subtype when omitted.
</ParamField>

<ParamField path="config.lineWidth" type="number">
  Line weight for the datum's 2D representation.
</ParamField>

<ParamField path="config.visibility" type="DatumVisibility">
  Whether this datum is shown in plan / model views.
</ParamField>

## Properties

<ResponseField name="ogid" type="string" />

<ResponseField name="ogType" type="string" />

<ResponseField name="subElements2D" type="Map<string, THREE.Object3D>" />

<ResponseField name="subElements3D" type="Map<string, THREE.Object3D>" />

<ResponseField name="selected" type="boolean" />

<ResponseField name="edit" type="boolean" />

<ResponseField name="locked" type="boolean" />

<ResponseField name="onDatumUpdated" type="Event<null>" />

<ResponseField name="propertySet" type="ProjectOriginOptions" />

<ResponseField name="labelName" type="string" />

<ResponseField name="datumType" type="DatumType">
  Read-only.
</ResponseField>

<ResponseField name="profileView" type="boolean" />

<ResponseField name="modelView" type="boolean" />

## Methods

### editableSchema

```typescript theme={null}
static editableSchema(): OPEditableSchema;
```

### move

```typescript theme={null}
move(delta: Vec3): void;
```

Translate this element by `delta` (world-space, meters).

### rotate

```typescript theme={null}
rotate(angleDeg: number, _axis?: Vec3, _anchor?: Vec3): void;
```

Rotate this element by `angleDeg` around `axis` (default Y-up), pivoted at `anchor` (default the element's own centroid).

### setOPConfig

```typescript theme={null}
setOPConfig(config: Partial<ProjectOriginOptions>): void;
```

### getOPConfig

```typescript theme={null}
getOPConfig(): ProjectOriginOptions;
```

### getEditAnchors

```typescript theme={null}
getEditAnchors(): EditAnchor[];
```

A single handle for the gizmo `position`, free on the floor plane.

### applyEditAnchor

```typescript theme={null}
applyEditAnchor(id: string, position: [
    number,
    number,
    number
]): void;
```

### setOPMaterial

```typescript theme={null}
setOPMaterial(): void;
```

### setOPGeometry

```typescript theme={null}
setOPGeometry(): void;
```

## Types

### ProjectOriginOptions

```typescript theme={null}
interface ProjectOriginOptions extends DatumOptionsBase {
  datumType: DatumType.PROJECT_ORIGIN;
  position: [number, number, number];
  rotationY: number;
  gizmoSize: number;
  surveyPoint?: SurveyPoint;
  showBenchmark: boolean;
}
```

### SurveyPoint

```typescript theme={null}
interface SurveyPoint {
  latitude: number;
  longitude: number;
  elevation: number;
  description?: string;
}
```

## Related

* [`OPElement`](/floorkit/api/architecture/op-element)
* [`DatumOptionsBase`](/floorkit/api/datums/level#datumoptionsbase)
* [`DatumType`](/floorkit/api/datums/datum-defaults#datumtype)
* [`EditAnchor`](/floorkit/api/architecture/op-element#editanchor)
* [`Event`](/floorkit/api/architecture/wall-network#event)
* [`IPlaceable`](/floorkit/api/architecture/op-element#iplaceable)
* [`IShape`](/floorkit/api/shapes/cuboid-shape#ishape)
* [`OPEditableSchema`](/floorkit/api/architecture/op-element#opeditableschema)
* [`Vec3`](/floorkit/api/architecture/wall#vec3)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.