Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document properties set by NearestPointOnLine on returned Point #155

Merged
merged 1 commit into from
Jan 25, 2024
Merged

Document properties set by NearestPointOnLine on returned Point #155

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions lib/src/nearest_point_on_line.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -183,6 +183,13 @@ _NearestMulti? _nearestPointOnMultiLine(
}

/// Takes a [Point] and a [LineString] and calculates the closest Point on the [LineString].
///
/// The properties of returned [Point] will contain three values:
/// * index: closest point was found on nth line part
/// * dist: distance between [point] and the closest point on line
/// * location: distance along the line between start and the closest point.
///
/// Example:
/// ```dart
/// var line = LineString(
/// coordinates: [
Expand Down
Loading