> ## 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.

# SectionLine

> A line in the plan that shows where a section cuts.

## Import

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

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

## Constructor

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

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

<ParamField path="config.start" type="[number, number, number]">
  Start of the cut line on the XZ plane.
</ParamField>

<ParamField path="config.end" type="[number, number, number]">
  End of the cut line on the XZ plane.
</ParamField>

<ParamField path="config.depth" type="{ near: number; far: number; }">
  Near / far view-depth clipping distances from the cut line.
</ParamField>

<ParamField path="config.flip" type="boolean">
  Flip the cut direction arrow.
</ParamField>

<ParamField path="config.jogs" type="[number, number, number][]">
  Additional interior vertices for stepped / jogged sections.
</ParamField>

<ParamField path="config.headStart" type="SectionHeadLabel">
  Head labels at either end of the cut.
</ParamField>

<ParamField path="config.headEnd" type="SectionHeadLabel" />

<ParamField path="config.linkedViewId" type="string">
  Identifier of the section view this line generates, if any.
</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="SectionLineOptions" />

<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<SectionLineOptions>): void;
```

### getOPConfig

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

### getEditAnchors

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

Draggable handles: the cut-line `start` and `end`, plus one per jog waypoint, each free on its own horizontal plane (Y preserved).

### 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

### SectionLineOptions

```typescript theme={null}
interface SectionLineOptions extends DatumOptionsBase {
  datumType: DatumType.SECTION_LINE;
  start: [number, number, number];
  end: [number, number, number];
  depth: {
    near: number;
    far: number;
  };
  flip: boolean;
  jogs?: [number, number, number][];
  headStart: SectionHeadLabel;
  headEnd: SectionHeadLabel;
  linkedViewId?: string;
}
```

### SectionHeadLabel

```typescript theme={null}
interface SectionHeadLabel {
  drawingNumber: string;
  sheetNumber: string;
}
```

<ResponseField name="drawingNumber" type="string" required>
  Drawing number assigned when the linked view is placed on a sheet.
</ResponseField>

<ResponseField name="sheetNumber" type="string" required>
  Sheet number carrying the linked view.
</ResponseField>

## 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.