tldraw/apps/docs/content/gen/intersectLineSegmentPolyline-function-1.mdx
alex c893a02878
remove lock option from highlighter (#1703)
Highlighter is autolocked, so we shouldn't show the lock icon 

### Change Type

- [x] `patch` — Bug fix


[^1]: publishes a `patch` release, for devDependencies use `internal`
[^2]: will not publish a new version

### Test Plan

1. Add a step-by-step description of how to test your PR here.
2.

- [ ] Unit Tests
- [ ] End to end tests

### Release Notes

- We no longer show the tool lock option for highlighter - it didn't do
anything anyway
2023-07-04 10:41:14 +00:00

88 lines
1,017 B
Text

---
title: intersectLineSegmentPolyline
status: published
category: primitives
group: Function
author: api
date: 06/23/2023
order: 43
---<Small>Public Function</Small>
Find the intersections between a line segment and a polyline.
##### Parameters
<ParametersTable>
<ParametersTableRow>
<ParametersTableName>
`a1`
</ParametersTableName>
<ParametersTableDescription>
```ts
VecLike
```
The segment's first point.
</ParametersTableDescription>
</ParametersTableRow>
<ParametersTableRow>
<ParametersTableName>
`a2`
</ParametersTableName>
<ParametersTableDescription>
```ts
VecLike
```
The segment's second point.
</ParametersTableDescription>
</ParametersTableRow>
<ParametersTableRow>
<ParametersTableName>
`points`
</ParametersTableName>
<ParametersTableDescription>
```ts
VecLike[]
```
The points in the polyline.
</ParametersTableDescription>
</ParametersTableRow>
</ParametersTable>
##### Returns
```ts
null | VecLike[]
```
##### References
[VecLike](/gen/primitives/VecLike-type)