---
title: "CanonicalTileID | 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.

# Class CanonicalTileID

#### Implements

-   [ICanonicalTileID](https://docs.maptiler.com/sdk-js/api-reference/interfaces/ICanonicalTileID/)

##### Index

### Constructors[](#constructors)

[constructor](#constructor)

### Properties[](#properties)

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

### Methods[](#methods)

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

## Constructors[](#constructors-1)

### constructor[](#constructor)

-   new CanonicalTileID(z: number, x: number, y: number): CanonicalTileID[](#constructorcanonicaltileid)
    
    #### Parameters
    
    -   z: number
    -   x: number
    -   y: number
    
    #### Returns CanonicalTileID
    

## Properties[](#properties-1)

### key[](#key)

key: string

Implementation of [ICanonicalTileID](https://docs.maptiler.com/sdk-js/api-reference/interfaces/ICanonicalTileID/).[key](https://docs.maptiler.com/sdk-js/api-reference/interfaces/ICanonicalTileID/#key)

### x[](#x)

x: number

Implementation of [ICanonicalTileID](https://docs.maptiler.com/sdk-js/api-reference/interfaces/ICanonicalTileID/).[x](https://docs.maptiler.com/sdk-js/api-reference/interfaces/ICanonicalTileID/#x)

### y[](#y)

y: number

Implementation of [ICanonicalTileID](https://docs.maptiler.com/sdk-js/api-reference/interfaces/ICanonicalTileID/).[y](https://docs.maptiler.com/sdk-js/api-reference/interfaces/ICanonicalTileID/#y)

### z[](#z)

z: number

Implementation of [ICanonicalTileID](https://docs.maptiler.com/sdk-js/api-reference/interfaces/ICanonicalTileID/).[z](https://docs.maptiler.com/sdk-js/api-reference/interfaces/ICanonicalTileID/#z)

## Methods[](#methods-1)

### equals[](#equals)

-   equals(id: [ICanonicalTileID](https://docs.maptiler.com/sdk-js/api-reference/interfaces/ICanonicalTileID/)): boolean[](#equals-1)
    
    #### Parameters
    
    -   id: [ICanonicalTileID](https://docs.maptiler.com/sdk-js/api-reference/interfaces/ICanonicalTileID/)
    
    #### Returns boolean
    
    Implementation of [ICanonicalTileID](https://docs.maptiler.com/sdk-js/api-reference/interfaces/ICanonicalTileID/).[equals](https://docs.maptiler.com/sdk-js/api-reference/interfaces/ICanonicalTileID/#equals)
    

### getTilePoint[](#gettilepoint)

-   getTilePoint(coord: [IMercatorCoordinate](https://docs.maptiler.com/sdk-js/api-reference/interfaces/IMercatorCoordinate/)): [Point](https://docs.maptiler.com/sdk-js/api-reference/classes/Externals.Point/)[](#gettilepoint-1)
    
    #### Parameters
    
    -   coord: [IMercatorCoordinate](https://docs.maptiler.com/sdk-js/api-reference/interfaces/IMercatorCoordinate/)
    
    #### Returns [Point](https://docs.maptiler.com/sdk-js/api-reference/classes/Externals.Point/)
    
    Implementation of [ICanonicalTileID](https://docs.maptiler.com/sdk-js/api-reference/interfaces/ICanonicalTileID/).[getTilePoint](https://docs.maptiler.com/sdk-js/api-reference/interfaces/ICanonicalTileID/#gettilepoint)
    

### isChildOf[](#ischildof)

-   isChildOf(parent: [ICanonicalTileID](https://docs.maptiler.com/sdk-js/api-reference/interfaces/ICanonicalTileID/)): boolean[](#ischildof-1)
    
    #### Parameters
    
    -   parent: [ICanonicalTileID](https://docs.maptiler.com/sdk-js/api-reference/interfaces/ICanonicalTileID/)
    
    #### Returns boolean
    
    Implementation of [ICanonicalTileID](https://docs.maptiler.com/sdk-js/api-reference/interfaces/ICanonicalTileID/).[isChildOf](https://docs.maptiler.com/sdk-js/api-reference/interfaces/ICanonicalTileID/#ischildof)
    

### toString[](#tostring)

-   toString(): string[](#tostring-1)
    
    #### Returns string
    
    Implementation of [ICanonicalTileID](https://docs.maptiler.com/sdk-js/api-reference/interfaces/ICanonicalTileID/).[toString](https://docs.maptiler.com/sdk-js/api-reference/interfaces/ICanonicalTileID/#tostring)
    

### url[](#url)

-   url(urls: string\[\], pixelRatio: number, scheme?: string | null): string[](#url-1)
    
    given a list of urls, choose a url template and return a tile URL
    
    #### Parameters
    
    -   urls: string\[\]
    -   pixelRatio: number
    -   `Optional`scheme: string | null
    
    #### Returns string
    
    Implementation of [ICanonicalTileID](https://docs.maptiler.com/sdk-js/api-reference/interfaces/ICanonicalTileID/).[url](https://docs.maptiler.com/sdk-js/api-reference/interfaces/ICanonicalTileID/#url)