Manifests Resources

Manifest resources that hold a list of other resources

Doc links: _BaseManifest _BaseResource _BaseUIDModel HasProperties View ViewMetadata

class lfview.resources.manifests.manifests._BaseManifest(**kwargs)

Base class for Manifest resources

Fundamentally, Manifests are defined by their contents, which is just a list of other resources. Manifests grant access to these other resources, so by sharing a Manifest you are also sharing the contents.

Required Properties:

• contents (a list of _BaseUIDModel instance or UID): The resources contained in this manifest; access to a manifest grants access to the resources listed in its contents, a list (each item is an instance of _BaseUIDModel or a valid uid property of that class)

Optional Properties:

• description (ShortString): Description of resource, a unicode string and less than 5000 characters
• name (ShortString): Name or title of resource, a unicode string and less than 300 characters
• uid (String): Unique object identifier, a unicode string

class lfview.resources.manifests.manifests.View(**kwargs)

Manifest class for visualizing Elements

Like all Manifests, Views grant access to their contents. Views are also used for visualizing data by highlighting the important Elements and including some visualization metadata.

In order for the View to grant access to certain elements, they must be specified in the contents list in addition to

Required Properties:

• contents (a list of _BaseUIDModel instance or UID): The resources contained in this manifest; access to a manifest grants access to the resources listed in its contents, a list (each item is an instance of _BaseUIDModel or a valid uid property of that class)
• elements (a list of _BaseElement instance or UID): A list of pointers to the elements in the View, a list (each item is an instance of _BaseElement or a valid uid property of that class) with length between 0 and 100

Optional Properties:

• description (ShortString): Description of resource, a unicode string and less than 5000 characters
• label_x (ShortString): X-axis label, a unicode string and less than 300 characters
• label_y (ShortString): Y-axis label, a unicode string and less than 300 characters
• label_z (ShortString): Z-axis label, a unicode string and less than 300 characters
• name (ShortString): Name or title of resource, a unicode string and less than 300 characters
• uid (String): Unique object identifier, a unicode string

class lfview.resources.manifests.manifests.ViewMetadata(**kwargs)

Metadata on View Manifests

This gives the View more meaning outside of simply the contents to provide context on visualization.

Optional Properties:

• description (ShortString): Description of resource, a unicode string and less than 5000 characters
• label_x (ShortString): X-axis label, a unicode string and less than 300 characters
• label_y (ShortString): Y-axis label, a unicode string and less than 300 characters
• label_z (ShortString): Z-axis label, a unicode string and less than 300 characters
• name (ShortString): Name or title of resource, a unicode string and less than 300 characters
• uid (String): Unique object identifier, a unicode string