Class: SubjectPackage

Defined in: SubjectPackage.ts:601

Constructors

Constructor

new SubjectPackage(manifest, options?): SubjectPackage;

Defined in: SubjectPackage.ts:605

Parameters

manifest

SubjectPackageManifest

options?

SubjectPackageOptions = {}

Returns

SubjectPackage

Properties

manifest

readonly manifest: SubjectPackageManifest;

Defined in: SubjectPackage.ts:602

---

validation

readonly validation: SubjectPackageValidationReport;

Defined in: SubjectPackage.ts:603

Accessors

id

Get Signature

get id(): string;

Defined in: SubjectPackage.ts:637

Returns

string

Methods

fromManifest()

static fromManifest(manifest, options?): SubjectPackage;

Defined in: SubjectPackage.ts:618

Parameters

manifest

SubjectPackageManifest

options?

SubjectPackageOptions = {}

Returns

SubjectPackage

---

load()

static load(url, options?): Promise<SubjectPackage>;

Defined in: SubjectPackage.ts:622

Parameters

url

string

options?

SubjectPackageLoadOptions = {}

Returns

Promise<SubjectPackage>

---

getSurfaceSet()

getSurfaceSet(id): SurfaceSetManifest | null;

Defined in: SubjectPackage.ts:641

Parameters

id

string

Returns

SurfaceSetManifest | null

---

getSurfaceVariant()

getSurfaceVariant(surfaceId, variantName?): 
  | SurfaceVariantManifest
  | null;

Defined in: SubjectPackage.ts:645

Parameters

surfaceId

string

variantName?

string

Returns

| SurfaceVariantManifest | null

---

getMetric()

getMetric(id): MetricManifest | null;

Defined in: SubjectPackage.ts:653

Parameters

id

string

Returns

MetricManifest | null

---

getTransform()

getTransform(id): TransformManifest | null;

Defined in: SubjectPackage.ts:657

Parameters

id

string

Returns

TransformManifest | null

---

getScene()

getScene(id?): SceneManifest | null;

Defined in: SubjectPackage.ts:661

Parameters

id?

string | undefined

Returns

SceneManifest | null