new DiscardMissingTileImagePolicy
A policy for discarding tile images that match a known image containing a "missing" image.
Parameters:
Name | Type | Argument | Default | Description |
---|---|---|---|---|
description.missingImageUrl |
String | The URL of the known missing image. | ||
description.pixelsToCheck |
Array | An array of Cartesian2 pixel positions to compare against the missing image. | ||
description.disableCheckIfAllPixelsAreTransparent |
Boolean |
<optional> |
false | If true, the discard check will be disabled if all of the pixelsToCheck in the missingImageUrl have an alpha value of 0. If false, the discard check will proceed no matter the values of the pixelsToCheck. |
Throws:
-
DeveloperError :
description.missingImageUrl
is required. -
DeveloperError :
pixelsToCheck
is required.
Methods
-
<static> prototype.isReady
-
Determines if the discard policy is ready to process images.
Returns:
True if the discard policy is ready to process images; otherwise, false. -
<static> prototype.shouldDiscardImage
-
Given a tile image, decide whether to discard that image.
Parameters:
Name Type Description image
Image An image to test. Throws:
DeveloperError :shouldDiscardImage
must not be called before the discard policy is ready.Returns:
True if the image should be discarded; otherwise, false.