Winter Cardinal UI - v0.457.0 / DThemeDiagramCanvasEditor

Interface: DThemeDiagramCanvasEditor

DBase theme.

Hierarchy

• DThemeDiagramCanvasBase

• DThemeDiagramCanvasEditorSnap

  ↳ DThemeDiagramCanvasEditor

Implemented by

• DThemeDarkDiagramCanvasEditor
• DThemeWhiteDiagramCanvasEditor

Table of contents

Methods

• getAlpha
• getBackgroundAlpha
• getBackgroundBase
• getBackgroundColor
• getBackgroundTexture
• getBorderAlign
• getBorderAlpha
• getBorderColor
• getBorderMask
• getBorderTexture
• getBorderWidth
• getClearType
• getColor
• getCornerMask
• getCornerRadius
• getCursor
• getFontFamilly
• getFontSize
• getFontStyle
• getFontVariant
• getFontWeight
• getHeight
• getInteractive
• getLineHeight
• getLocalBoundsLimit
• getOutlineAlign
• getOutlineAlpha
• getOutlineColor
• getOutlineMask
• getOutlineOffset
• getOutlineWidth
• getPaddingBottom
• getPaddingLeft
• getPaddingRight
• getPaddingTop
• getShadow
• getSnapGridMajorAlpha
• getSnapGridMajorColor
• getSnapGridMajorInterval
• getSnapGridMajorStyle
• getSnapGridMajorWidth
• getSnapGridMinorAlpha
• getSnapGridMinorColor
• getSnapGridMinorStyle
• getSnapGridMinorWidth
• getSnapGridSize
• getSnapTargetAlpha
• getSnapTargetColor
• getSnapTargetStyle
• getSnapTargetWidth
• getTitle
• getWeight
• getWidth
• getX
• getY
• isAmbient
• newShadow
• newShadowWeak
• newState

Methods

getAlpha

▸ getAlpha(state): number

Parameters

Name	Type
state	DBaseStateSet

Returns

number

Inherited from

DThemeDiagramCanvasBase.getAlpha

Defined in

src/main/typescript/wcardinal/ui/d-font.ts:34

---

getBackgroundAlpha

▸ getBackgroundAlpha(state): number

Returns a background alpha.

Parameters

Name	Type	Description
state	DBaseStateSet	a state

Returns

number

Inherited from

DThemeDiagramCanvasBase.getBackgroundAlpha

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:551

---

getBackgroundBase

▸ getBackgroundBase(): null | number

Returns

null | number

Inherited from

DThemeDiagramCanvasBase.getBackgroundBase

Defined in

src/main/typescript/wcardinal/ui/d-diagram-canvas-base.ts:33

---

getBackgroundColor

▸ getBackgroundColor(state): null | number

Returns a background color. If the color is null, backgrounds are not be rendered.

Parameters

Name	Type	Description
state	DBaseStateSet	a state

Returns

null | number

Inherited from

DThemeDiagramCanvasBase.getBackgroundColor

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:544

---

getBackgroundTexture

▸ getBackgroundTexture(): Texture

Returns a background texture.

Returns

Texture

Inherited from

DThemeDiagramCanvasBase.getBackgroundTexture

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:556

---

getBorderAlign

▸ getBorderAlign(state): number

Returns a border align.

Parameters

Name	Type	Description
state	DBaseStateSet	a state

Returns

number

Inherited from

DThemeDiagramCanvasBase.getBorderAlign

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:585

---

getBorderAlpha

▸ getBorderAlpha(state): number

Returns a border alpha.

Parameters

Name	Type	Description
state	DBaseStateSet	a state

Returns

number

Inherited from

DThemeDiagramCanvasBase.getBorderAlpha

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:571

---

getBorderColor

▸ getBorderColor(state): null | number

Returns a border color. If the color is null, borders are not be rendered.

Parameters

Name	Type	Description
state	DBaseStateSet	a state

Returns

null | number

Inherited from

DThemeDiagramCanvasBase.getBorderColor

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:564

---

getBorderMask

▸ getBorderMask(state): number

Returns a border mask.

Parameters

Name	Type	Description
state	DBaseStateSet	a mask

Returns

number

Inherited from

DThemeDiagramCanvasBase.getBorderMask

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:592

---

getBorderTexture

▸ getBorderTexture(): Texture

Returns a border texture.

Returns

Texture

Inherited from

DThemeDiagramCanvasBase.getBorderTexture

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:597

---

getBorderWidth

▸ getBorderWidth(state): number

Returns a border width.

Parameters

Name	Type	Description
state	DBaseStateSet	a state

Returns

number

Inherited from

DThemeDiagramCanvasBase.getBorderWidth

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:578

---

getClearType

▸ getClearType(): number

Returns a clear type. A clear type is for layout classes including DLayoutVertical.

Returns

number

Inherited from

DThemeDiagramCanvasBase.getClearType

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:697

---

getColor

▸ getColor(state): number

Parameters

Name	Type
state	DBaseStateSet

Returns

number

Inherited from

DThemeDiagramCanvasBase.getColor

Defined in

src/main/typescript/wcardinal/ui/d-font.ts:33

---

getCornerMask

▸ getCornerMask(): number

Returns a corner mask.

Returns

number

Inherited from

DThemeDiagramCanvasBase.getCornerMask

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:627

---

getCornerRadius

▸ getCornerRadius(): number

Returns a corner radius.

Returns

number

Inherited from

DThemeDiagramCanvasBase.getCornerRadius

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:622

---

getCursor

▸ getCursor(state): string

Returns a cursor.

Parameters

Name	Type
state	DBaseStateSet

Returns

string

Inherited from

DThemeDiagramCanvasBase.getCursor

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:719

---

getFontFamilly

▸ getFontFamilly(): string

Returns

string

Inherited from

DThemeDiagramCanvasBase.getFontFamilly

Defined in

src/main/typescript/wcardinal/ui/d-font.ts:28

---

getFontSize

▸ getFontSize(): number

Returns

number

Inherited from

DThemeDiagramCanvasBase.getFontSize

Defined in

src/main/typescript/wcardinal/ui/d-font.ts:29

---

getFontStyle

▸ getFontStyle(): DFontStyle

Returns

DFontStyle

Inherited from

DThemeDiagramCanvasBase.getFontStyle

Defined in

src/main/typescript/wcardinal/ui/d-font.ts:31

---

getFontVariant

▸ getFontVariant(): DFontVariant

Returns

DFontVariant

Inherited from

DThemeDiagramCanvasBase.getFontVariant

Defined in

src/main/typescript/wcardinal/ui/d-font.ts:32

---

getFontWeight

▸ getFontWeight(): DFontWeight

Returns

DFontWeight

Inherited from

DThemeDiagramCanvasBase.getFontWeight

Defined in

src/main/typescript/wcardinal/ui/d-font.ts:30

---

getHeight

▸ getHeight(): DCoordinateSize

Returns a height.

Returns

DCoordinateSize

Inherited from

DThemeDiagramCanvasBase.getHeight

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:531

---

getInteractive

▸ getInteractive(): number

Returns an interactivity.

Returns

number

Inherited from

DThemeDiagramCanvasBase.getInteractive

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:681

---

getLineHeight

▸ getLineHeight(): number

Returns

number

Inherited from

DThemeDiagramCanvasBase.getLineHeight

Defined in

src/main/typescript/wcardinal/ui/d-font.ts:35

---

getLocalBoundsLimit

▸ getLocalBoundsLimit(): number

Returns

number

Inherited from

DThemeDiagramCanvasBase.getLocalBoundsLimit

Defined in

src/main/typescript/wcardinal/ui/d-diagram-canvas-base.ts:34

---

getOutlineAlign

▸ getOutlineAlign(state): number

Returns an outline align.

Parameters

Name	Type	Description
state	DBaseStateSet	a state

Returns

number

Inherited from

DThemeDiagramCanvasBase.getOutlineAlign

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:663

---

getOutlineAlpha

▸ getOutlineAlpha(state): number

Returns an outline alpha.

Parameters

Name	Type	Description
state	DBaseStateSet	a state

Returns

number

Inherited from

DThemeDiagramCanvasBase.getOutlineAlpha

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:642

---

getOutlineColor

▸ getOutlineColor(state): null | number

Returns an outline color. If the color is null, outlines are not be rendered.

Parameters

Name	Type	Description
state	DBaseStateSet	a state

Returns

null | number

Inherited from

DThemeDiagramCanvasBase.getOutlineColor

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:635

---

getOutlineMask

▸ getOutlineMask(state): number

Returns an outline mask.

Parameters

Name	Type	Description
state	DBaseStateSet	a state

Returns

number

Inherited from

DThemeDiagramCanvasBase.getOutlineMask

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:670

---

getOutlineOffset

▸ getOutlineOffset(state): number

Returns an outline offset.

Parameters

Name	Type	Description
state	DBaseStateSet	a state

Returns

number

Inherited from

DThemeDiagramCanvasBase.getOutlineOffset

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:656

---

getOutlineWidth

▸ getOutlineWidth(state): number

Returns an outline width.

Parameters

Name	Type	Description
state	DBaseStateSet	a state

Returns

number

Inherited from

DThemeDiagramCanvasBase.getOutlineWidth

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:649

---

getPaddingBottom

▸ getPaddingBottom(): number

Returns a bottom padding.

Returns

number

Inherited from

DThemeDiagramCanvasBase.getPaddingBottom

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:617

---

getPaddingLeft

▸ getPaddingLeft(): number

Returns a left padding.

Returns

number

Inherited from

DThemeDiagramCanvasBase.getPaddingLeft

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:602

---

getPaddingRight

▸ getPaddingRight(): number

Returns a right padding.

Returns

number

Inherited from

DThemeDiagramCanvasBase.getPaddingRight

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:607

---

getPaddingTop

▸ getPaddingTop(): number

Returns a top padding.

Returns

number

Inherited from

DThemeDiagramCanvasBase.getPaddingTop

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:612

---

getShadow

▸ getShadow(): null | DShadow

Returns a shadow. If a shadow is null, no shadow is rendered.

Returns

null | DShadow

Inherited from

DThemeDiagramCanvasBase.getShadow

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:676

---

getSnapGridMajorAlpha

▸ getSnapGridMajorAlpha(): number

Returns

number

Inherited from

DThemeDiagramCanvasEditorSnap.getSnapGridMajorAlpha

Defined in

src/main/typescript/wcardinal/ui/d-diagram-canvas-editor-snap.ts:62

---

getSnapGridMajorColor

▸ getSnapGridMajorColor(): number

Returns

number

Inherited from

DThemeDiagramCanvasEditorSnap.getSnapGridMajorColor

Defined in

src/main/typescript/wcardinal/ui/d-diagram-canvas-editor-snap.ts:61

---

getSnapGridMajorInterval

▸ getSnapGridMajorInterval(): number

Returns

number

Inherited from

DThemeDiagramCanvasEditorSnap.getSnapGridMajorInterval

Defined in

src/main/typescript/wcardinal/ui/d-diagram-canvas-editor-snap.ts:60

---

getSnapGridMajorStyle

▸ getSnapGridMajorStyle(): number

Returns

number

Inherited from

DThemeDiagramCanvasEditorSnap.getSnapGridMajorStyle

Defined in

src/main/typescript/wcardinal/ui/d-diagram-canvas-editor-snap.ts:64

---

getSnapGridMajorWidth

▸ getSnapGridMajorWidth(): number

Returns

number

Inherited from

DThemeDiagramCanvasEditorSnap.getSnapGridMajorWidth

Defined in

src/main/typescript/wcardinal/ui/d-diagram-canvas-editor-snap.ts:63

---

getSnapGridMinorAlpha

▸ getSnapGridMinorAlpha(): number

Returns

number

Inherited from

DThemeDiagramCanvasEditorSnap.getSnapGridMinorAlpha

Defined in

src/main/typescript/wcardinal/ui/d-diagram-canvas-editor-snap.ts:67

---

getSnapGridMinorColor

▸ getSnapGridMinorColor(): number

Returns

number

Inherited from

DThemeDiagramCanvasEditorSnap.getSnapGridMinorColor

Defined in

src/main/typescript/wcardinal/ui/d-diagram-canvas-editor-snap.ts:66

---

getSnapGridMinorStyle

▸ getSnapGridMinorStyle(): number

Returns

number

Inherited from

DThemeDiagramCanvasEditorSnap.getSnapGridMinorStyle

Defined in

src/main/typescript/wcardinal/ui/d-diagram-canvas-editor-snap.ts:69

---

getSnapGridMinorWidth

▸ getSnapGridMinorWidth(): number

Returns

number

Inherited from

DThemeDiagramCanvasEditorSnap.getSnapGridMinorWidth

Defined in

src/main/typescript/wcardinal/ui/d-diagram-canvas-editor-snap.ts:68

---

getSnapGridSize

▸ getSnapGridSize(): DDiagramCanvasEditorSnapGridSize

Returns

DDiagramCanvasEditorSnapGridSize

Inherited from

DThemeDiagramCanvasEditorSnap.getSnapGridSize

Defined in

src/main/typescript/wcardinal/ui/d-diagram-canvas-editor-snap.ts:71

---

getSnapTargetAlpha

▸ getSnapTargetAlpha(): number

Returns

number

Inherited from

DThemeDiagramCanvasEditorSnap.getSnapTargetAlpha

Defined in

src/main/typescript/wcardinal/ui/d-diagram-canvas-editor-snap.ts:74

---

getSnapTargetColor

▸ getSnapTargetColor(): number

Returns

number

Inherited from

DThemeDiagramCanvasEditorSnap.getSnapTargetColor

Defined in

src/main/typescript/wcardinal/ui/d-diagram-canvas-editor-snap.ts:73

---

getSnapTargetStyle

▸ getSnapTargetStyle(): number

Returns

number

Inherited from

DThemeDiagramCanvasEditorSnap.getSnapTargetStyle

Defined in

src/main/typescript/wcardinal/ui/d-diagram-canvas-editor-snap.ts:76

---

getSnapTargetWidth

▸ getSnapTargetWidth(): number

Returns

number

Inherited from

DThemeDiagramCanvasEditorSnap.getSnapTargetWidth

Defined in

src/main/typescript/wcardinal/ui/d-diagram-canvas-editor-snap.ts:75

---

getTitle

▸ getTitle(): string

Returns a tooltip text.

Returns

string

Inherited from

DThemeDiagramCanvasBase.getTitle

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:691

---

getWeight

▸ getWeight(): number

Returns a weight. Weights are for layout classes including DLayoutVertical. If a weight is less than or equals to zero, layout classes are supposed not to change a width / height.

Returns

number

Inherited from

DThemeDiagramCanvasBase.getWeight

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:704

---

getWidth

▸ getWidth(): DCoordinateSize

Returns a width.

Returns

DCoordinateSize

Inherited from

DThemeDiagramCanvasBase.getWidth

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:536

---

getX

▸ getX(): DCoordinatePosition

Returns a X coordinate.

Returns

DCoordinatePosition

Inherited from

DThemeDiagramCanvasBase.getX

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:521

---

getY

▸ getY(): DCoordinatePosition

Returns a Y coordinate.

Returns

DCoordinatePosition

Inherited from

DThemeDiagramCanvasBase.getY

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:526

---

isAmbient

▸ isAmbient(): boolean

Returns

boolean

Inherited from

DThemeDiagramCanvasBase.isAmbient

Defined in

src/main/typescript/wcardinal/ui/d-diagram-canvas-base.ts:32

---

newShadow

▸ newShadow(): null | DShadow

Creates a new shadow.

Returns

null | DShadow

Inherited from

DThemeDiagramCanvasBase.newShadow

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:709

---

newShadowWeak

▸ newShadowWeak(): null | DShadow

Creates a new weak shadow.

Returns

null | DShadow

Inherited from

DThemeDiagramCanvasBase.newShadowWeak

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:714

---

newState

▸ newState(state): void

Returns true if focusable.

Parameters

Name	Type
state	DBaseStateSet

Returns

void

Inherited from

DThemeDiagramCanvasBase.newState

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:686

Edit this page.