Share via

Point2D interface

  • Reference
Package:
@azure/cognitiveservices-visualsearch

Defines a 2D point with X and Y coordinates.

Properties

alternateName

An alias for the item. NOTE: This property will not be serialized. It can only be populated by the server.
bingId

An ID that uniquely identifies this item. NOTE: This property will not be serialized. It can only be populated by the server.
description

A short description of the item. NOTE: This property will not be serialized. It can only be populated by the server.
id

A String identifier. NOTE: This property will not be serialized. It can only be populated by the server.
image

An image of the item. NOTE: This property will not be serialized. It can only be populated by the server.
name

The name of the thing represented by this object. NOTE: This property will not be serialized. It can only be populated by the server.
readLink

The URL that returns this resource. To use the URL, append query parameters as appropriate and include the Ocp-Apim-Subscription-Key header. NOTE: This property will not be serialized. It can only be populated by the server.
url

The URL to get more information about the thing represented by this object. NOTE: This property will not be serialized. It can only be populated by the server.
webSearchUrl

The URL to Bing's search result for this item. NOTE: This property will not be serialized. It can only be populated by the server.
x

The x-coordinate of the point.
y

The y-coordinate of the point.

Property Details

alternateName

An alias for the item. NOTE: This property will not be serialized. It can only be populated by the server.

alternateName?: string

Property Value

string

bingId

An ID that uniquely identifies this item. NOTE: This property will not be serialized. It can only be populated by the server.

bingId?: string

Property Value

string

description

A short description of the item. NOTE: This property will not be serialized. It can only be populated by the server.

description?: string

Property Value

string

id

A String identifier. NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

image

An image of the item. NOTE: This property will not be serialized. It can only be populated by the server.

image?: ImageObject

Property Value

ImageObject

name

The name of the thing represented by this object. NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

The URL that returns this resource. To use the URL, append query parameters as appropriate and include the Ocp-Apim-Subscription-Key header. NOTE: This property will not be serialized. It can only be populated by the server.

readLink?: string

Property Value

string

url

The URL to get more information about the thing represented by this object. NOTE: This property will not be serialized. It can only be populated by the server.

url?: string

Property Value

string

webSearchUrl

The URL to Bing's search result for this item. NOTE: This property will not be serialized. It can only be populated by the server.

webSearchUrl?: string

Property Value

string

x

The x-coordinate of the point.

x: number

Property Value

number

y

The y-coordinate of the point.

y: number

Property Value

number