Class FramingDecision

Hierarchy

HandleWrapper
- FramingDecision

Constructors

constructor

new FramingDecision(
    opts: {
        anchorPoint?: PointFloat;
        dimensions?: DimensionsFloat;
        framingIntentId: string;
        id: string;
        label?: string;
        protectionAnchorPoint?: PointFloat | null;
        protectionDimensions?: DimensionsFloat | null;
    },
): FramingDecision
Parameters
- opts: {
      anchorPoint?: PointFloat;
      dimensions?: DimensionsFloat;
      framingIntentId: string;
      id: string;
      label?: string;
      protectionAnchorPoint?: PointFloat | null;
      protectionDimensions?: DimensionsFloat | null;
  }
Returns FramingDecision
Overrides HandleWrapper.constructor
- Defined in src/framing-decision.ts:44

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

anchorPoint

get anchorPoint(): PointFloat
anchorPoint

Returns PointFloat
- Defined in src/framing-decision.ts:156
set anchorPoint(value: PointFloat): void
Parameters
- value: PointFloat
Returns void
- Defined in src/framing-decision.ts:162

customAttrs

get customAttrs(): Record<string, CustomAttrValue>
Returns Record<string, CustomAttrValue>
- Defined in src/framing-decision.ts:360

customAttrsCount

get customAttrsCount(): number
Returns number
- Defined in src/framing-decision.ts:355

dimensions

get dimensions(): DimensionsFloat
dimensions

Returns DimensionsFloat
- Defined in src/framing-decision.ts:141
set dimensions(value: DimensionsFloat): void
Parameters
- value: DimensionsFloat
Returns void
- Defined in src/framing-decision.ts:147

framingIntentId

get framingIntentId(): string
framingIntentId

Returns string
- Defined in src/framing-decision.ts:132

id

get id(): string
id

Returns string
- Defined in src/framing-decision.ts:118

label

get label(): string
label

Returns string
- Defined in src/framing-decision.ts:125

protectionAnchorPoint

get protectionAnchorPoint(): PointFloat | null
protectionAnchorPoint

Returns PointFloat | null
- Defined in src/framing-decision.ts:194
set protectionAnchorPoint(value: PointFloat): void
Parameters
- value: PointFloat
Returns void
- Defined in src/framing-decision.ts:204

protectionDimensions

get protectionDimensions(): DimensionsFloat | null
protectionDimensions

Returns DimensionsFloat | null
- Defined in src/framing-decision.ts:171
set protectionDimensions(value: DimensionsFloat | null): void
Parameters
- value: DimensionsFloat | null
Returns void
- Defined in src/framing-decision.ts:181

Methods

`Protected`_checkHandle

_checkHandle(): void
Check that the handle is still valid. Throws if closed.

Returns void
Inherited from HandleWrapper._checkHandle
- Defined in src/base.ts:59

adjustAnchorPoint

adjustAnchorPoint(canvas: Canvas, hMethod: HAlign, vMethod: VAlign): void
Adjust anchor point based on alignment within canvas.
Parameters
- canvas: Canvas
- hMethod: HAlign
- vMethod: VAlign
Returns void
- Defined in src/framing-decision.ts:263

adjustProtectionAnchorPoint

adjustProtectionAnchorPoint(
    canvas: Canvas,
    hMethod: HAlign,
    vMethod: VAlign,
): void
Adjust protection anchor point based on alignment within canvas.
Parameters
- canvas: Canvas
- hMethod: HAlign
- vMethod: VAlign
Returns void
- Defined in src/framing-decision.ts:274

asDict

asDict(): Record<string, unknown>
Returns Record<string, unknown>
- Defined in src/framing-decision.ts:217

asJson

asJson(indent?: number): string
Parameters
- indent: number = 0
Returns string
- Defined in src/framing-decision.ts:224

equals

equals(other: string | FramingDecision): boolean
Parameters
- other: string | FramingDecision
Returns boolean
- Defined in src/framing-decision.ts:212

getCustomAttr

getCustomAttr(name: string): CustomAttrValue | null
Parameters
- name: string
Returns CustomAttrValue | null
- Defined in src/framing-decision.ts:335

getProtectionRect

getProtectionRect(): Rect | null
Get protection rect or None if not defined.

Returns Rect | null
- Defined in src/framing-decision.ts:243

getRect

getRect(): Rect
Get framing rect as (anchor_x, anchor_y, width, height).

Returns Rect
- Defined in src/framing-decision.ts:236

hasCustomAttr

hasCustomAttr(name: string): boolean
Parameters
- name: string
Returns boolean
- Defined in src/framing-decision.ts:340

populateFromIntent

populateFromIntent(
    canvas: Canvas,
    framingIntent: FramingIntent,
    rounding?: RoundStrategy | null,
): void
Populate this framing decision from a canvas and framing intent (in-place).
Parameters
- canvas: Canvas
- framingIntent: FramingIntent
- rounding: RoundStrategy | null = null
Returns void
- Defined in src/framing-decision.ts:311

removeCustomAttr

removeCustomAttr(name: string): boolean
Parameters
- name: string
Returns boolean
- Defined in src/framing-decision.ts:345

setCustomAttr

setCustomAttr(name: string, value: CustomAttrValue): void
Parameters
- name: string
- value: CustomAttrValue
Returns void
- Defined in src/framing-decision.ts:330

setProtection

setProtection(dims: DimensionsFloat, anchor: PointFloat): void
Set protection dimensions and anchor point on this framing decision.
Parameters
- dims: DimensionsFloat
- anchor: PointFloat
Returns void
- Defined in src/framing-decision.ts:253

toJSON

toJSON(): Record<string, unknown>
Returns Record<string, unknown>
- Defined in src/framing-decision.ts:231

`Static`fromFramingIntent

fromFramingIntent(
    canvas: Canvas,
    framingIntent: FramingIntent,
    rounding?: RoundStrategy | null,
): FramingDecision
Create a FramingDecision from a canvas and framing intent.
Parameters
- canvas: Canvas
- framingIntent: FramingIntent
- rounding: RoundStrategy | null = null
Returns FramingDecision
- Defined in src/framing-decision.ts:289

Class FramingDecision

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns FramingDecision

Properties

Protected_addon

Protected_docRef

Accessors

anchorPoint

Returns PointFloat

Parameters

Returns void

customAttrs

Returns Record<string, CustomAttrValue>

customAttrsCount

Returns number

dimensions

Returns DimensionsFloat

Parameters

Returns void

framingIntentId

Returns string

id

Returns string

label

Returns string

protectionAnchorPoint

Returns PointFloat | null

Parameters

Returns void

protectionDimensions

Returns DimensionsFloat | null

Parameters

Returns void

Methods

Protected_checkHandle

Returns void

adjustAnchorPoint

Parameters

Returns void

adjustProtectionAnchorPoint

Parameters

Returns void

asDict

Returns Record<string, unknown>

asJson

Parameters

Returns string

equals

Parameters

Returns boolean

getCustomAttr

Parameters

Returns CustomAttrValue | null

getProtectionRect

Returns Rect | null

getRect

Returns Rect

hasCustomAttr

Parameters

Returns boolean

populateFromIntent

Parameters

Returns void

removeCustomAttr

Parameters

Returns boolean

setCustomAttr

Parameters

Returns void

setProtection

Parameters

Returns void

`Protected`_addon

`Protected`_docRef

`Protected`_checkHandle

`Static`fromFramingIntent