Scrawl-canvas API
    Preparing search index...

    Interface EnhancedLabelSaveInputs

    interface EnhancedLabelSaveInputs {
        accessibleText?: string;
        accessibleTextOrder?: number;
        accessibleTextPlaceholder?: string;
        accessibleTextRole?: string;
        alignment?: number;
        alignTextUnitsToPath?: boolean;
        autoHyphenate?: boolean;
        breakTextOnSpaces?: boolean;
        breakWordsOnHyphens?: boolean;
        cacheOutput?: boolean;
        calculateOrder?: number;
        checkDeltaConstraints?: boolean;
        checkHitUseTemplate?: boolean;
        cjkPunctuationBinding?: boolean;
        constantSpeedAlongPath?: boolean;
        delta?: EnhancedLabelFactoryDeltaInputs;
        deltaConstraints?: CommonObjectInput;
        dimensions?: CommonTwoElementArrayInput;
        direction?: string;
        fillStyle?: string | StylesInstance;
        filter?: string;
        filters?: string | FilterInstance | (string | FilterInstance)[];
        flipReverse?: boolean;
        flipUpend?: boolean;
        font?: string;
        fontFamily?: string;
        fontKerning?: string;
        fontSize?: string;
        fontStretch?: string;
        fontString?: string;
        fontStyle?: string;
        fontVariantCaps?: string;
        fontWeight?: string;
        globalAlpha?: number;
        globalCompositeOperation?: string;
        group?: string | GroupInstance;
        guidelineDash?: number[];
        guidelineStyle?: string;
        guidelineWidth?: number;
        handle?: CommonTwoElementArrayInput;
        handleX?: StringOrNumberInput;
        handleY?: StringOrNumberInput;
        height?: StringOrNumberInput;
        highlightStyle?: string | StylesInstance;
        hyphenString?: string;
        imageSmoothingEnabled?: boolean;
        imageSmoothingQuality?: string;
        includeDefaults?: boolean | string[];
        includeHighlight?: boolean;
        includeOverline?: boolean;
        includeUnderline?: boolean;
        isStencil?: boolean;
        justifyLine?: TextLineJustifyValues;
        language?: string;
        layoutTemplate?: string | ArtefactInstance;
        letterSpacing?: StringOrNumberInput;
        lineAdjustment?: number;
        lineBreakHook?: (text: string, lang: string) => string | string[];
        lineBreakInsert?: "soft" | "zwsp";
        lineCap?: LineCapValues;
        lineDash?: number[];
        lineDashOffset?: number;
        lineJoin?: LineJoinValues;
        lineSpacing?: number;
        lineWidth?: number;
        lockFillStyleToEntity?: boolean;
        lockStrokeStyleToEntity?: boolean;
        memoizeFilterOutput?: boolean;
        method?: "draw" | "fill" | "drawAndFill" | "fillAndDraw";
        miterLimit?: number;
        name?: string;
        noDeltaUpdates?: boolean;
        offset?: CommonTwoElementArrayInput;
        offsetX?: StringOrNumberInput;
        offsetY?: StringOrNumberInput;
        order?: number;
        overlineOffset?: number;
        overlineStyle?: string | StylesInstance;
        overlineWidth?: number;
        pathPosition?: number;
        performDeltaChecks?: boolean;
        roll?: number;
        scale?: number;
        shadowBlur?: number;
        shadowColor?: string;
        shadowOffsetX?: number;
        shadowOffsetY?: number;
        showGuidelines?: boolean;
        stampOrder?: number;
        start?: CommonTwoElementArrayInput;
        startTextOnLine?: number;
        startX?: StringOrNumberInput;
        startY?: StringOrNumberInput;
        strokeStyle?: string | StylesInstance;
        text?: string;
        textHandle?: [
            EnhancedLabelTextUnitHandleXValues,
            EnhancedLabelTextUnitHandleYValues,
        ];
        textHandleX?: EnhancedLabelTextUnitHandleXValues;
        textHandleY?: EnhancedLabelTextUnitHandleYValues;
        textIsAccessible?: boolean;
        textOffset?: [PercentOrNumberInput, PercentOrNumberInput];
        textOffsetX?: PercentOrNumberInput;
        textOffsetY?: PercentOrNumberInput;
        textRendering?: string;
        textUnitFlow?: TextUnitFlowValues;
        truncateString?: string;
        underlineGap?: number;
        underlineOffset?: number;
        underlineStyle?: string | StylesInstance;
        underlineWidth?: number;
        useLayoutTemplateAsPath?: boolean;
        verticalCjkPunctuation?: "off" | "auto" | "forced";
        visibility?: boolean;
        width?: StringOrNumberInput;
        wordSpacing?: StringOrNumberInput;
    }

    Hierarchy (View Summary)

    Index

    Properties

    accessibleText? accessibleTextOrder? accessibleTextPlaceholder? accessibleTextRole? alignment? alignTextUnitsToPath? autoHyphenate? breakTextOnSpaces? breakWordsOnHyphens? cacheOutput? calculateOrder? checkDeltaConstraints? checkHitUseTemplate? cjkPunctuationBinding? constantSpeedAlongPath? delta? deltaConstraints? dimensions? direction? fillStyle? filter? filters? flipReverse? flipUpend? font? fontFamily? fontKerning? fontSize? fontStretch? fontString? fontStyle? fontVariantCaps? fontWeight? globalAlpha? globalCompositeOperation? group? guidelineDash? guidelineStyle? guidelineWidth? handle? handleX? handleY? height? highlightStyle? hyphenString? imageSmoothingEnabled? imageSmoothingQuality? includeDefaults? includeHighlight? includeOverline? includeUnderline? isStencil? justifyLine? language? layoutTemplate? letterSpacing? lineAdjustment? lineBreakHook? lineBreakInsert? lineCap? lineDash? lineDashOffset? lineJoin? lineSpacing? lineWidth? lockFillStyleToEntity? lockStrokeStyleToEntity? memoizeFilterOutput? method? miterLimit? name? noDeltaUpdates? offset? offsetX? offsetY? order? overlineOffset? overlineStyle? overlineWidth? pathPosition? performDeltaChecks? roll? scale? shadowBlur? shadowColor? shadowOffsetX? shadowOffsetY? showGuidelines? stampOrder? start? startTextOnLine? startX? startY? strokeStyle? text? textHandle? textHandleX? textHandleY? textIsAccessible? textOffset? textOffsetX? textOffsetY? textRendering? textUnitFlow? truncateString? underlineGap? underlineOffset? underlineStyle? underlineWidth? useLayoutTemplateAsPath? verticalCjkPunctuation? visibility? width? wordSpacing?

    Properties

    accessibleText?: string
    accessibleTextOrder?: number
    accessibleTextPlaceholder?: string
    accessibleTextRole?: string
    alignment?: number
    alignTextUnitsToPath?: boolean
    autoHyphenate?: boolean
    breakTextOnSpaces?: boolean
    breakWordsOnHyphens?: boolean
    cacheOutput?: boolean
    calculateOrder?: number
    checkDeltaConstraints?: boolean
    checkHitUseTemplate?: boolean
    cjkPunctuationBinding?: boolean
    constantSpeedAlongPath?: boolean
    deltaConstraints?: CommonObjectInput
    direction?: string
    fillStyle?: string | StylesInstance
    filter?: string
    filters?: string | FilterInstance | (string | FilterInstance)[]
    flipReverse?: boolean
    flipUpend?: boolean
    font?: string
    fontFamily?: string
    fontKerning?: string
    fontSize?: string
    fontStretch?: string
    fontString?: string
    fontStyle?: string
    fontVariantCaps?: string
    fontWeight?: string
    globalAlpha?: number
    globalCompositeOperation?: string
    group?: string | GroupInstance
    guidelineDash?: number[]
    guidelineStyle?: string
    guidelineWidth?: number
    highlightStyle?: string | StylesInstance
    hyphenString?: string
    imageSmoothingEnabled?: boolean
    imageSmoothingQuality?: string
    includeDefaults?: boolean | string[]
    includeHighlight?: boolean
    includeOverline?: boolean
    includeUnderline?: boolean
    isStencil?: boolean
    justifyLine?: TextLineJustifyValues
    language?: string
    layoutTemplate?: string | ArtefactInstance
    letterSpacing?: StringOrNumberInput
    lineAdjustment?: number
    lineBreakHook?: (text: string, lang: string) => string | string[]
    lineBreakInsert?: "soft" | "zwsp"
    lineCap?: LineCapValues
    lineDash?: number[]
    lineDashOffset?: number
    lineJoin?: LineJoinValues
    lineSpacing?: number
    lineWidth?: number
    lockFillStyleToEntity?: boolean
    lockStrokeStyleToEntity?: boolean
    memoizeFilterOutput?: boolean
    method?: "draw" | "fill" | "drawAndFill" | "fillAndDraw"
    miterLimit?: number
    name?: string
    noDeltaUpdates?: boolean
    order?: number
    overlineOffset?: number
    overlineStyle?: string | StylesInstance
    overlineWidth?: number
    pathPosition?: number
    performDeltaChecks?: boolean
    roll?: number
    scale?: number
    shadowBlur?: number
    shadowColor?: string
    shadowOffsetX?: number
    shadowOffsetY?: number
    showGuidelines?: boolean
    stampOrder?: number
    startTextOnLine?: number
    strokeStyle?: string | StylesInstance
    text?: string
    textIsAccessible?: boolean
    textOffsetX?: PercentOrNumberInput
    textOffsetY?: PercentOrNumberInput
    textRendering?: string
    textUnitFlow?: TextUnitFlowValues
    truncateString?: string
    underlineGap?: number
    underlineOffset?: number
    underlineStyle?: string | StylesInstance
    underlineWidth?: number
    useLayoutTemplateAsPath?: boolean
    verticalCjkPunctuation?: "off" | "auto" | "forced"
    visibility?: boolean
    wordSpacing?: StringOrNumberInput