PublishableLayer | References | ArcGIS Maps SDK for JavaScript

Types

import type { PublishableLayer } from "@arcgis/core/layers/mixins/PublishableLayer.js";

Subclasses:: FeatureLayer

Since: ArcGIS Maps SDK for JavaScript 4.25

Mixin for layers that expose the publishing status of the underlying service.

Properties

Property	Type	Class
`publishingInfo` readonly	`PublishingInfo \| null`

publishingInfo

readonly Property

Type: PublishingInfo | null

Checks layer's publishing status while the layer is being published to the portal. This stops when the status has been determined or when the layer is destroyed. The layer is automatically refreshed when the layer is done publishing. This is valid only for ArcGIS Online hosted feature services.

Example

// Log the current publishing status after each checks.
when(
  () => !layer.publishingInfo.updating,
  (status) => {
    switch (layer.publishingInfo.status) {
      case "unknown":
        console.log("The layer's publishing status is unknown at this point");
        break;
      case "unavailable":
        console.log("The layer doesn't provide publishing information");
        break;
      case "publishing":
        console.log("Layer is publishing");
        break;
      case "published":
        console.log("Layer is published at", layer.url);
        break;
    }
  },
  { initial: true }
);

Type definitions

PublishStatus

Type definition

Layer's publishing status while the layer is being published to the portal. The layer is automatically refreshed when the status goes from publishing to unavailable or published.

Possible Values

Value	Description
unknown	The layer's publishing status is unknown at this point.
unavailable	The layer doesn't provide publishing information.
publishing	The publishing is in progress.
published	The layer is published and ready for consumption.

See also

PublishingInfo.status

Type: "unknown" | "unavailable" | "publishing" | "published"