Variable ViewpointSchemaConst

ViewpointSchema: ZodObject<{
    index: ZodNumber;
    snapshot: ZodString;
    snapshotImage: ZodString;
    uuid: ZodString;
    viewpoint: ZodString;
}, "strip", ZodTypeAny, {
    index: number;
    snapshot: string;
    snapshotImage: string;
    uuid: string;
    viewpoint: string;
}, {
    index: number;
    snapshot: string;
    snapshotImage: string;
    uuid: string;
    viewpoint: string;
}> = ...

The markup file can contain multiple viewpoints related to one or more comments. A viewpoint has also the Guid attribute for identifying it uniquely.

Viewpoints are immutable, therefore they should never be changed once created. If new comments on a topic require different visualization, new viewpoints should be added.

Type declaration

  • index: ZodNumber

    Parameter for sorting.

  • snapshot: ZodString

    Filename of the snapshot (png or jpeg).

  • snapshotImage: ZodString

    The image data of the snapshot.

    Not a part of the BCF spec, used internally.

  • uuid: ZodString

    The unique identifier of the entity.

    This is not in the BCF spec, but is used internally. However, when a BCF component requires a GUID, the uuid property is used.

  • viewpoint: ZodString

    Filename of the viewpoint (.bcfv).

Type declaration

  • index: number

    Parameter for sorting.

  • snapshot: string

    Filename of the snapshot (png or jpeg).

  • snapshotImage: string

    The image data of the snapshot.

    Not a part of the BCF spec, used internally.

  • uuid: string

    The unique identifier of the entity.

    This is not in the BCF spec, but is used internally. However, when a BCF component requires a GUID, the uuid property is used.

  • viewpoint: string

    Filename of the viewpoint (.bcfv).

Type declaration

  • index: number

    Parameter for sorting.

  • snapshot: string

    Filename of the snapshot (png or jpeg).

  • snapshotImage: string

    The image data of the snapshot.

    Not a part of the BCF spec, used internally.

  • uuid: string

    The unique identifier of the entity.

    This is not in the BCF spec, but is used internally. However, when a BCF component requires a GUID, the uuid property is used.

  • viewpoint: string

    Filename of the viewpoint (.bcfv).

Generated using TypeDoc