docsby gkjohnson

CesiumIonAuthPlugin

Plugin for authenticating requests to Cesium Ion. Handles token refresh, asset endpoint resolution, and attribution collection. Auto-registration of terrain and imagery plugins via assetTypeHandler is deprecated — provide a custom handler instead.

Loading a Cesium ion asset
import { TilesRenderer } from '3d-tiles-renderer/three';
import { CesiumIonAuthPlugin } from '3d-tiles-renderer/three/plugins';

const tiles = new TilesRenderer();
tiles.registerPlugin( new CesiumIonAuthPlugin( {
	apiToken: 'YOUR_CESIUM_ION_TOKEN',
	assetId: '2275207',
	autoRefreshToken: true,
} ) );
On this page

Methods

constructor

new CesiumIonAuthPlugin(
	options?: {
		// Cesium Ion API token.
		apiToken?: string,

		// Cesium Ion asset ID, or `null` when using an explicit root URL.
		assetId: string | null = null,

		// Automatically refresh the token on 4xx errors.
		autoRefreshToken: boolean = false,

		// Apply recommended renderer settings for Cesium Ion assets.
		useRecommendedSettings: boolean = true,

		// Callback `(type, tiles, asset)` invoked for non-3DTILES asset types.
		assetTypeHandler?: function
	}
)