Class: PanelPreviewInstructionsExtension
Extension that creates and exposes previewInstructions for Panels
Hierarchy
BaseExtension↳
PanelPreviewInstructionsExtension
Constructors
constructor
• new PanelPreviewInstructionsExtension(designState, authProvider, cimDocStore)
Parameters
| Name | Type |
|---|---|
designState | DesignState |
authProvider | AuthProvider |
cimDocStore | CimDocStore |
Overrides
BaseExtension.constructor
Defined in
Properties
authProvider
• Protected authProvider: AuthProvider
Defined in
cimDocStore
• Protected cimDocStore: CimDocStore
Defined in
designState
• Protected designState: PanelState
Overrides
BaseExtension.designState
Defined in
disposeInstructionsUrlReaction
• Private disposeInstructionsUrlReaction: IReactionDisposer
Defined in
instructionsUrl
• Optional instructionsUrl: string
Internally persisted observable for the instructions Url.
Remarks
Intended to help in abstracting the methods and requirements by which preview instructions must be generated based on a panel/document's properties
Defined in
inject
▪ Static inject: string[]
Overrides
BaseExtension.inject
Defined in
Accessors
cimDocInfo
• Private get cimDocInfo(): Object
Private helper to compose CimDoc info needed elsewhere
Returns
Object
| Name | Type |
|---|---|
fontRepositoryUrl | string |
panel | Panel |
version | string |
Defined in
transientInstructions
• get transientInstructions(): string
This computed attribute builds and returns transient previewInstructionsUrl for a panel.
Remarks
We use "transient" here because the value returned is a representation of the entire document encoded in an instructions URL (rather than persisting the document internally).
Returns
string
Defined in
Methods
dispose
▸ dispose(): void
Returns
void
Overrides
BaseExtension.dispose
Defined in
getInstructionsUrl
▸ Protected getInstructionsUrl(): Promise<string>
Async method that builds and returns a shortened previewInstructionsUrl via saving to UDS.
Returns
Promise<string>
Defined in
setInstructionsUrl
▸ Protected setInstructionsUrl(instructionsUrl): void
Parameters
| Name | Type |
|---|---|
instructionsUrl | string |
Returns
void
Defined in
supports
▸ Static supports(state): boolean
Parameters
| Name | Type |
|---|---|
state | DesignState |
Returns
boolean
Overrides
BaseExtension.supports