[@kineviz/graphxr-api](../README.md) / [Exports](../modules.md) / ShortestPathOptions

# Interface: ShortestPathOptions

## Table of contents

### Properties

- [sourceId](ShortestPathOptions.md#sourceid)
- [targetId](ShortestPathOptions.md#targetid)
- [weightProperty](ShortestPathOptions.md#weightproperty)

## Properties

### sourceId

• **sourceId**: [`NodeId`](../modules.md#nodeid)

#### Defined in

[path-finding/shortestPath.ts:7](https://bitbucket.org/kineviz/graphxr-api/src/c752a8c/src/path-finding/shortestPath.ts#lines-7)

___

### targetId

• **targetId**: [`NodeId`](../modules.md#nodeid)

#### Defined in

[path-finding/shortestPath.ts:8](https://bitbucket.org/kineviz/graphxr-api/src/c752a8c/src/path-finding/shortestPath.ts#lines-8)

___

### weightProperty

• `Optional` **weightProperty**: [`PropertyKey`](../modules.md#propertykey)

#### Defined in

[path-finding/shortestPath.ts:9](https://bitbucket.org/kineviz/graphxr-api/src/c752a8c/src/path-finding/shortestPath.ts#lines-9)