Class Variant

Variant Class A Variant is a variant of the ordinal. It's a visual distinct visual representation. It can be 2D and / or 3D or any other variation. Not to be confused with Composition.

Hierarchy

Exportable
- Variant

Index

Constructors

Properties

id type? name? onDisplay? onHide? onExport?

Methods

show hide canExport export

Constructors

constructor

new Variant(options): Variant
Parameters
- options: IVariant
Returns Variant
Overrides Exportable.constructor
- Defined in src/models/globals/Variant.ts:30

Properties

id

id: string

`Optional`type

type?: OrdinalType

`Optional`name

name?: string

`Optional`onDisplay

onDisplay?: (() => Promise<void>)

`Optional`onHide

onHide?: (() => Promise<void>)

`Optional`onExport

onExport?: (() => Promise<Export>)

Methods

show

show(): Promise<void>
Returns Promise<void>
- Defined in src/models/globals/Variant.ts:39

hide

hide(): Promise<void>
Returns Promise<void>
- Defined in src/models/globals/Variant.ts:70

canExport

canExport(): boolean
Returns boolean
Inherited from Exportable.canExport
- Defined in src/models/utilities/Export.ts:32

export

export(): Promise<string>
Returns Promise<string>
Inherited from Exportable.export
- Defined in src/models/utilities/Export.ts:36