---
title: "ICanonicalTileID | JavaScript maps SDK"
description: "Documentation for MapTiler SDK"
---

> For AI agents: a documentation index is available at [/llms.txt](https://docs.maptiler.com/llms.txt). Markdown versions of all pages are available by appending .md to any URL.

# Interface ICanonicalTileID

interface ICanonicalTileID {  
    [key](#key): string;  
    [x](#x): number;  
    [y](#y): number;  
    [z](#z): number;  
    [equals](#equals-1)(id: ICanonicalTileID): boolean;  
    [getTilePoint](#gettilepoint-1)(coord: [IMercatorCoordinate](https://docs.maptiler.com/sdk-js/api-reference/interfaces/IMercatorCoordinate/)): [Point2D](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Point2D/);  
    [isChildOf](#ischildof-1)(parent: ICanonicalTileID): boolean;  
    [toString](#tostring-1)(): string;  
    [url](#url-1)(urls: string\[\], pixelRatio: number, scheme: string | null): string;  
}

#### Implemented by

-   [CanonicalTileID](https://docs.maptiler.com/sdk-js/api-reference/classes/Externals.CanonicalTileID/)

##### Index

### Properties[](#properties)

[key](#key) [x](#x) [y](#y) [z](#z)

### Methods[](#methods)

[equals](#equals) [getTilePoint](#gettilepoint) [isChildOf](#ischildof) [toString](#tostring) [url](#url)

## Properties[](#properties-1)

### key[](#key)

key: string

### x[](#x)

x: number

### y[](#y)

y: number

### z[](#z)

z: number

## Methods[](#methods-1)

### equals[](#equals)

-   equals(id: ICanonicalTileID): boolean[](#equals-1)
    
    #### Parameters
    
    -   id: ICanonicalTileID
    
    #### Returns boolean
    

### getTilePoint[](#gettilepoint)

-   getTilePoint(coord: [IMercatorCoordinate](https://docs.maptiler.com/sdk-js/api-reference/interfaces/IMercatorCoordinate/)): [Point2D](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Point2D/)[](#gettilepoint-1)
    
    #### Parameters
    
    -   coord: [IMercatorCoordinate](https://docs.maptiler.com/sdk-js/api-reference/interfaces/IMercatorCoordinate/)
    
    #### Returns [Point2D](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Point2D/)
    

### isChildOf[](#ischildof)

-   isChildOf(parent: ICanonicalTileID): boolean[](#ischildof-1)
    
    #### Parameters
    
    -   parent: ICanonicalTileID
    
    #### Returns boolean
    

### toString[](#tostring)

-   toString(): string[](#tostring-1)
    
    #### Returns string
    

### url[](#url)

-   url(urls: string\[\], pixelRatio: number, scheme: string | null): string[](#url-1)
    
    #### Parameters
    
    -   urls: string\[\]
    -   pixelRatio: number
    -   scheme: string | null
    
    #### Returns string