Class: MapCachedCanvasLayerCanvasInstanceClass
Defined in: src/sdk/components/map/layers/MapCachedCanvasLayer.ts:199
An implementation of MapCachedCanvasLayerCanvasInstance.
Extends
Implements
Constructors
Constructor
new MapCachedCanvasLayerCanvasInstanceClass(
canvas
,context
,isDisplayed
,getReferenceMargin
):MapCachedCanvasLayerCanvasInstanceClass
Defined in: src/sdk/components/map/layers/MapCachedCanvasLayer.ts:223
Creates a new canvas instance.
Parameters
Parameter | Type | Description |
---|---|---|
canvas | HTMLCanvasElement | The canvas element. |
context | CanvasRenderingContext2D | The canvas 2D rendering context. |
isDisplayed | boolean | Whether the canvas is displayed. |
getReferenceMargin | () => number | A function which gets this canvas instance's reference margin, in pixels. The reference margin is the maximum amount of translation allowed without invalidation at a scale factor of 1. |
Returns
MapCachedCanvasLayerCanvasInstanceClass
Overrides
MapCanvasLayerCanvasInstanceClass
.constructor
Properties
canvas
readonly
canvas:HTMLCanvasElement
Defined in: src/sdk/components/map/layers/MapCanvasLayer.tsx:46
The canvas element.
Implementation of
MapCachedCanvasLayerCanvasInstance
.canvas
Inherited from
MapCanvasLayerCanvasInstanceClass
.canvas
context
readonly
context:CanvasRenderingContext2D
Defined in: src/sdk/components/map/layers/MapCanvasLayer.tsx:47
The canvas 2D rendering context.
Implementation of
MapCachedCanvasLayerCanvasInstance
.context
Inherited from
MapCanvasLayerCanvasInstanceClass
.context
isDisplayed
readonly
isDisplayed:boolean
Defined in: src/sdk/components/map/layers/MapCanvasLayer.tsx:48
Whether the canvas is displayed.
Implementation of
MapCachedCanvasLayerCanvasInstance
.isDisplayed
Inherited from
MapCanvasLayerCanvasInstanceClass
.isDisplayed
Accessors
geoProjection
Get Signature
get geoProjection():
GeoProjection
Defined in: src/sdk/components/map/layers/MapCachedCanvasLayer.ts:250
The projection used to draw this instance's canvas image.
Returns
The projection used to draw this instance's canvas image.
Implementation of
MapCachedCanvasLayerCanvasInstance
.geoProjection
isInvalid
Get Signature
get isInvalid():
boolean
Defined in: src/sdk/components/map/layers/MapCachedCanvasLayer.ts:245
Whether this instance's transform is invalid.
Returns
boolean
Whether this instance's transform is invalid.
Implementation of
MapCachedCanvasLayerCanvasInstance
.isInvalid
reference
Get Signature
get reference():
MapCachedCanvasLayerReference
Defined in: src/sdk/components/map/layers/MapCachedCanvasLayer.ts:235
This instance's map projection reference. The rendering of items to this instance's canvas is based on this reference.
Returns
This instance's map projection reference. The rendering of items to this instance's canvas is based on this reference.
Implementation of
MapCachedCanvasLayerCanvasInstance
.reference
transform
Get Signature
get transform():
MapCachedCanvasLayerTransform
Defined in: src/sdk/components/map/layers/MapCachedCanvasLayer.ts:240
This instance's transform.
Returns
This instance's transform.
Implementation of
MapCachedCanvasLayerCanvasInstance
.transform
Methods
clear()
clear():
void
Defined in: src/sdk/components/map/layers/MapCanvasLayer.tsx:53
Clears this canvas.
Returns
void
Implementation of
MapCachedCanvasLayerCanvasInstance
.clear
Inherited from
MapCanvasLayerCanvasInstanceClass
.clear
invalidate()
invalidate():
void
Defined in: src/sdk/components/map/layers/MapCachedCanvasLayer.ts:314
Invalidates this canvas instance. This also clears the canvas.
Returns
void
Implementation of
MapCachedCanvasLayerCanvasInstance
.invalidate
reset()
reset():
void
Defined in: src/sdk/components/map/layers/MapCanvasLayer.tsx:58
Resets this instance's canvas. This will erase the canvas of all drawn pixels, reset its state (including all styles, transformations, and cached paths), and clear the Coherent GT command buffer associated with it.
Returns
void
Implementation of
MapCachedCanvasLayerCanvasInstance
.reset
Inherited from
MapCanvasLayerCanvasInstanceClass
.reset
syncWithCanvasInstance()
syncWithCanvasInstance(
other
):void
Defined in: src/sdk/components/map/layers/MapCachedCanvasLayer.ts:268
Syncs this canvas instance with another canvas instance.
Parameters
Parameter | Type | Description |
---|---|---|
other | MapCachedCanvasLayerCanvasInstance | the canvas instance with which to sync. |
Returns
void
Implementation of
MapCachedCanvasLayerCanvasInstance
.syncWithCanvasInstance
syncWithMapProjection()
syncWithMapProjection(
mapProjection
):void
Defined in: src/sdk/components/map/layers/MapCachedCanvasLayer.ts:255
Syncs this canvas instance with the current map projection.
Parameters
Parameter | Type | Description |
---|---|---|
mapProjection | MapProjection | The current map projection. |
Returns
void
Implementation of
MapCachedCanvasLayerCanvasInstance
.syncWithMapProjection
transformCanvasElement()
protected
transformCanvasElement():void
Defined in: src/sdk/components/map/layers/MapCachedCanvasLayer.ts:301
Transforms this instance's canvas element.
Returns
void
updateTransform()
updateTransform(
mapProjection
):void
Defined in: src/sdk/components/map/layers/MapCachedCanvasLayer.ts:283
Updates this canvas instance's transform given the current map projection.
Parameters
Parameter | Type | Description |
---|---|---|
mapProjection | MapProjection | The current map projection. |
Returns
void