CanvasMBSource (Geotools modules 31-SNAPSHOT API)

Object
- MBSource
- - MediaMBSource
  - - CanvasMBSource

```
public class CanvasMBSource
extends MediaMBSource
```
Wrapper around a JSONObject containing a Mapbox canvas source.

See Also:

https://www.mapbox.com/mapbox-gl-js/style-spec/#sources-canvas

Field Summary
- Fields inherited from class MBSource
  json, parser

Constructor Summary

Constructors
Constructor Description

CanvasMBSource(JSONObject json)

CanvasMBSource(JSONObject json, MBObjectParser parser)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Boolean`	`getAnimate()`	(Optional) Defaults to true.
`String`	`getCanvas()`	(Required) HTML ID of the canvas from which to read pixels.
`String`	`getType()`	Type of source.

Methods inherited from class MediaMBSource
getCoordinates

Methods inherited from class MBSource
create

Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - CanvasMBSource
```
public CanvasMBSource(JSONObject json)
```
  - CanvasMBSource
```
public CanvasMBSource(JSONObject json,
                      MBObjectParser parser)
```
- Method Detail
  - getCanvas
```
public String getCanvas()
```
    (Required) HTML ID of the canvas from which to read pixels.
    
    Returns:
    
    String value for the HTML ID
  - getAnimate
```
public Boolean getAnimate()
```
    (Optional) Defaults to true. Whether the canvas source is animated. If the canvas is static, animate should be set to false to improve performance.
    
    Returns:
    
    Boolean for whether the source is animated, defaulting to true.
  - getType
```
public String getType()
```
    Description copied from class: MBSource
    
    Type of source.
    
    Specified by:
    
    getType in class MBSource
    
    Returns:
    
    One of "vector", "raster", "geojson", "image", "video", "canvas".