Package software.aws.awsprototypingsdk.cdkgraphplugindiagram

Interface IDiagramConfig.Jsii$Default

All Superinterfaces:

IDiagramConfig, IDiagramConfigBase, IDiagramConfigBase.Jsii$Default, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

IDiagramConfig.Jsii$Proxy

Enclosing interface:

IDiagramConfig

@Internal
public static interface IDiagramConfig.Jsii$Default
extends IDiagramConfig, IDiagramConfigBase.Jsii$Default

Internal default implementation for IDiagramConfig.

Nested Class Summary

Nested classes/interfaces inherited from interface software.aws.awsprototypingsdk.cdkgraphplugindiagram.IDiagramConfig

IDiagramConfig.Jsii$Default, IDiagramConfig.Jsii$Proxy

Nested classes/interfaces inherited from interface software.aws.awsprototypingsdk.cdkgraphplugindiagram.IDiagramConfigBase

IDiagramConfigBase.Jsii$Default, IDiagramConfigBase.Jsii$Proxy

Method Summary

Modifier and Type	Method	Description
default software.aws.awsprototypingsdk.cdkgraph.IGraphFilterPlan	getFilterPlan()	(experimental) Graph Filter Plan used to generate a unique diagram.
default Object	getFormat()	(experimental) The output format(s) to generated.
default Boolean	getIgnoreDefaults()	(experimental) Indicates if default diagram config is applied as defaults to this config.
default String	getName()	(experimental) Name of the diagram.
default Object	getTheme()	(experimental) Config for graph theme.
default String	getTitle()	(experimental) The title of the diagram.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getFilterPlan

@Stability(Experimental)
@Nullable
default software.aws.awsprototypingsdk.cdkgraph.IGraphFilterPlan getFilterPlan()

(experimental) Graph Filter Plan used to generate a unique diagram.

Specified by:

getFilterPlan in interface IDiagramConfigBase

Specified by:

getFilterPlan in interface IDiagramConfigBase.Jsii$Default

getFormat

@Stability(Experimental)
@Nullable
default Object getFormat()

(experimental) The output format(s) to generated.

Default: `DiagramFormat.PNG` - which will through extension also generate `DiagramFormat.SVG` and `DiagramFormat.DOT`

Specified by:

getFormat in interface IDiagramConfigBase

Specified by:

getFormat in interface IDiagramConfigBase.Jsii$Default

getTheme

@Stability(Experimental)
@Nullable
default Object getTheme()

(experimental) Config for graph theme.

Specified by:

getTheme in interface IDiagramConfigBase

Specified by:

getTheme in interface IDiagramConfigBase.Jsii$Default

getName

@Stability(Experimental)
@NotNull
default String getName()

(experimental) Name of the diagram.

Used as the basename of the generated file(s) which gets the extension appended.

Specified by:

getName in interface IDiagramConfig

getTitle

@Stability(Experimental)
@NotNull
default String getTitle()

(experimental) The title of the diagram.

Specified by:

getTitle in interface IDiagramConfig

getIgnoreDefaults

@Stability(Experimental)
@Nullable
default Boolean getIgnoreDefaults()

(experimental) Indicates if default diagram config is applied as defaults to this config.

Default: false

Specified by:

getIgnoreDefaults in interface IDiagramConfig