Enum DiagramFormat

  • All Implemented Interfaces:
    Serializable, Comparable<DiagramFormat>

    @Generated(value="jsii-pacmak/1.71.0 (build f1f58ae)",
               date="2022-11-28T05:22:28.486Z")
    @Stability(Experimental)
    public enum DiagramFormat
    extends Enum<DiagramFormat>
    (experimental) Supported diagram formats that can be generated.

    Extended formats are automatically generated, for example if you generate "png" which extends "svg" which extends "dot", the resulting generated files will be all aforementioned.

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      DOT
      (experimental) Graphviz [DOT Language](https://graphviz.org/doc/info/lang.html).
      PNG
      (experimental) [PNG](https://en.wikipedia.org/wiki/Portable_Network_Graphics) generated using [sharp](https://sharp.pixelplumbing.com/api-output#png) from DiagramFormat.SVG file.
      SVG
      (experimental) [SVG](https://developer.mozilla.org/en-US/docs/Web/SVG) generated using [dot-wasm](https://hpcc-systems.github.io/hpcc-js-wasm/classes/graphviz.Graphviz.html) from DiagramFormat.DOT file.
    • Enum Constant Detail

      • DOT

        @Stability(Experimental)
        public static final DiagramFormat DOT
        (experimental) Graphviz [DOT Language](https://graphviz.org/doc/info/lang.html).
      • SVG

        @Stability(Experimental)
        public static final DiagramFormat SVG
        (experimental) [SVG](https://developer.mozilla.org/en-US/docs/Web/SVG) generated using [dot-wasm](https://hpcc-systems.github.io/hpcc-js-wasm/classes/graphviz.Graphviz.html) from DiagramFormat.DOT file.
      • PNG

        @Stability(Experimental)
        public static final DiagramFormat PNG
        (experimental) [PNG](https://en.wikipedia.org/wiki/Portable_Network_Graphics) generated using [sharp](https://sharp.pixelplumbing.com/api-output#png) from DiagramFormat.SVG file.
    • Method Detail

      • values

        public static DiagramFormat[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
        for (DiagramFormat c : DiagramFormat.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static DiagramFormat valueOf​(String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        IllegalArgumentException - if this enum type has no constant with the specified name
        NullPointerException - if the argument is null