@asc-mitc/fdl — Node.js API
    Preparing search index...

    Class CanvasTemplate

    Hierarchy

    • HandleWrapper
      • CanvasTemplate
    Index

    Constructors

    constructor

    Properties

    _addon _docRef

    Accessors

    alignmentMethodHorizontal alignmentMethodVertical customAttrs customAttrsCount fitMethod fitSource id label maximumDimensions padToMaximum preserveFromSourceCanvas round targetAnamorphicSqueeze targetDimensions

    Methods

    _checkHandle apply asDict asJson equals getCustomAttr hasCustomAttr removeCustomAttr setCustomAttr toJSON

    Constructors

    • Parameters

      • opts: {
            alignmentMethodHorizontal?: HAlign;
            alignmentMethodVertical?: VAlign;
            fitMethod?: FitMethod;
            fitSource?: GeometryPath;
            id: string;
            label?: string;
            maximumDimensions?: DimensionsInt | null;
            padToMaximum?: boolean;
            preserveFromSourceCanvas?: GeometryPath | null;
            round?: RoundStrategy;
            targetAnamorphicSqueeze?: number;
            targetDimensions: DimensionsInt;
        }

      Returns CanvasTemplate

    Properties

    Protected_addon

    _addon: NativeAddon

    Cached addon reference.

    Protected_docRef

    _docRef: OwnedHandle | null

    Strong reference to the owning document. Prevents GC of the document while this child handle lives. For OwnedHandle, this is this (self-referencing).

    Accessors

    Methods

    Protected_checkHandle

    • _checkHandle(): void

      Check that the handle is still valid. Throws if closed.

      Returns void

    • Apply this canvas template to a source canvas/framing decision.

      Parameters

      • sourceCanvas: Canvas
      • sourceFraming: FramingDecision
      • newCanvasId: string
      • newFdName: string
      • sourceContextLabel: string | null = null
      • contextCreator: string | null = null

      Returns TemplateResult

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods