@kismet.ts/core / Exports / SequencePositionManager
Class: SequencePositionManager
Table of contents
Constructors
Properties
Methods
Constructors
constructor
• new SequencePositionManager(options)
Parameters
| Name | Type |
|---|---|
options | SequencePositionManagerOptions<SchemaItemNames> |
Defined in
managers/PositionManager.ts:27
Properties
options
• options: Required<layoutOptions>
Defined in
managers/PositionManager.ts:24
projectId
• Optional Readonly projectId: ProcessId
Defined in
managers/PositionManager.ts:22
schema
• Optional schema: SequenceSchemaOptions<SchemaItemNames>[]
Defined in
managers/PositionManager.ts:25
style
• Readonly style: PositionStyleOption
Defined in
managers/PositionManager.ts:21
Methods
_validateOptions
▸ Private _validateOptions(sequence): null | Sequence
Parameters
| Name | Type |
|---|---|
sequence | Sequence |
Returns
null | Sequence
Defined in
managers/PositionManager.ts:36
applySchema
▸ Protected applySchema(sequence, schema?): KismetItemPosition[]
Parameters
| Name | Type |
|---|---|
sequence | Sequence |
schema? | SequenceSchemaOptions<SchemaItemNames> |
Returns
KismetItemPosition[]
Defined in
managers/PositionManager.ts:115
applyStyle
▸ Protected applyStyle(inputItems, layout): KismetItemPosition[]
Parameters
| Name | Type |
|---|---|
inputItems | (SequenceItemType | Sequence)[] |
layout | Object |
layout.options | Required<layoutOptions> |
layout.style | Omit<PositionStyleOption, "schema" | "none"> |
layout.type? | SchemaItemNames |
layout.variables? | SequenceSchemaVariableOptions[] |
Returns
KismetItemPosition[]
Defined in
managers/PositionManager.ts:137
fillPositions
▸ fillPositions(sequence): Sequence
Parameters
| Name | Type |
|---|---|
sequence | Sequence |
Returns
Defined in
managers/PositionManager.ts:190
variablePositions
▸ Private variablePositions(item, items, positions, options): KismetItemPosition[]
Parameters
| Name | Type |
|---|---|
item | SequenceItemType |
items | (SequenceItemType | Sequence)[] |
positions | KismetItemPosition[] |
options | SequenceSchemaVariableOptions |
Returns
KismetItemPosition[]