Class TextShape

Extends Shape to implement a text shape.

To change vertical text from "bottom to top" to "top to bottom", the following code can be used:

TextShape.prototype.verticalTextRotation = 90;

Hierarchy (view full)

Constructors

constructor

Properties

align antiAlias background baseSpacingBottom baseSpacingLeft baseSpacingRight baseSpacingTop border boundingBox bounds cacheEnabled clipped color cursor dialect direction endArrow endSize family fill fillOpacity flipH flipV fontStyle glass gradient gradientDirection horizontal ignoreClippedStringSize ignoreStringSize image imageSrc indicator indicatorColor indicatorDirection indicatorGradientColor indicatorImageSrc indicatorShape indicatorStrokeColor isDashed isRounded isShadow labelPadding lastValue margin minSvgStrokeWidth node oldGradients opacity originalPointerEvents outline overflow overlay pointerEvents points preserveImageAspect replaceLinefeeds rotation scale shapePointerEvents size spacing spacingBottom spacingLeft spacingRight spacingTop startArrow startSize state stencil stencilPointerEvents stroke strokeOpacity strokeWidth style svgPointerEvents svgStrokeTolerance textDirection unrotatedBoundingBox useSvgBoundingBox valign value verticalTextRotation visible wrap

Methods

addPoints afterPaint apply augmentBoundingBox beforePaint checkBounds clear configureCanvas create createBoundingBox createCanvas createSvgCanvas createTransparentSvgRectangle destroy destroyCanvas getArcSize getAutoDirection getContentNode getCursor getGradientBounds getHtmlValue getLabelBounds getLabelMargins getRotation getShapeRotation getSpacing getSvgScreenOffset getTextCss getTextRotation init initStyles isHtmlAllowed isPaintBoundsInverted isRoundable paint paintBackground paintEdgeShape paintForeground paintGlassEffect paintVertexShape redraw redrawHtmlShape redrawShape releaseSvgGradients resetStyles setCursor setTransparentBackgroundImage updateBoundingBox updateBoundsFromPoints updateFont updateInnerHtml updateMargin updateSize updateTransform updateValue

Constructors

constructor

  • new TextShape(value, bounds, align?, valign?, color?, family?, size?, fontStyle?, spacing?, spacingTop?, spacingRight?, spacingBottom?, spacingLeft?, horizontal?, background?, border?, wrap?, clipped?, overflow?, labelPadding?, textDirection?): TextShape

  • Parameters

    • value: string | HTMLElement | SVGGElement
    • bounds: Rectangle
    • align: AlignValue = ALIGN.CENTER
    • valign: VAlignValue = ALIGN.MIDDLE
    • color: string = 'black'
    • family: string = DEFAULT_FONTFAMILY
    • size: number = DEFAULT_FONTSIZE
    • fontStyle: number = DEFAULT_FONTSTYLE
    • spacing: number = 2
    • spacingTop: number = 0
    • spacingRight: number = 0
    • spacingBottom: number = 0
    • spacingLeft: number = 0
    • horizontal: boolean = true
    • background: string = NONE
    • border: string = NONE
    • wrap: boolean = false
    • clipped: boolean = false
    • overflow: OverflowValue = 'visible'
    • labelPadding: number = 0
    • textDirection: TextDirectionValue = DEFAULT_TEXT_DIRECTION

    Returns TextShape

Properties

align

align: AlignValue

antiAlias

antiAlias: boolean = true

Rendering hint for configuring the canvas.

background

background: string

baseSpacingBottom

baseSpacingBottom: number = 0

Specifies the spacing to be added to the bottom spacing. Default is 0. Use the value 1 here to get the same label positions as in mxGraph 1.x.

baseSpacingLeft

baseSpacingLeft: number = 0

Specifies the spacing to be added to the left spacing. Default is 0.

baseSpacingRight

baseSpacingRight: number = 0

Specifies the spacing to be added to the right spacing. Default is 0.

baseSpacingTop

baseSpacingTop: number = 0

Specifies the spacing to be added to the top spacing. Default is 0. Use the value 5 here to get the same label positions as in mxGraph 1.x.

border

border: string

boundingBox

boundingBox: null | Rectangle = null

Contains the bounding box of the shape, that is, the smallest rectangle that includes all pixels of the shape.

bounds

bounds: Rectangle

Holds the Rectangle that specifies the bounds of this shape.

cacheEnabled

cacheEnabled: boolean = true

Specifies if caching for HTML labels should be enabled. Default is true.

clipped

clipped: boolean

color

color: string

cursor

cursor: string = ''

dialect

dialect: null | string = null

Holds the dialect in which the shape is to be painted. This can be one of the DIALECT constants in Constants.

direction

direction: DirectionValue = DIRECTION.EAST

endArrow

endArrow: string = NONE

endSize

endSize: number = 1

family

family: string

fill

fill: string = NONE

fillOpacity

fillOpacity: number = 100

flipH

flipH: boolean = false

flipV

flipV: boolean = false

fontStyle

fontStyle: number

glass

glass: boolean = false

gradient

gradient: string = NONE

gradientDirection

gradientDirection: DirectionValue = DIRECTION.EAST

horizontal

horizontal: boolean

ignoreClippedStringSize

ignoreClippedStringSize: boolean = true

Specifies if the string size should be measured in if the label is clipped and the label position is center and middle. If this is true, then the bounding box will be set to . Default is true. has precedence over this switch.

ignoreStringSize

ignoreStringSize: boolean = false

Specifies if the actual string size should be measured. If disabled the boundingBox will not ignore the actual size of the string, otherwise will be used instead. Default is false.

image

image: null | ImageBox = null

imageSrc

imageSrc: null | string = null

indicator

indicator: null | Shape = null

indicatorColor

indicatorColor: string = NONE

indicatorDirection

indicatorDirection: DirectionValue = DIRECTION.EAST

indicatorGradientColor

indicatorGradientColor: string = NONE

indicatorImageSrc

indicatorImageSrc: null | string = null

indicatorShape

indicatorShape: null | typeof Shape = null

indicatorStrokeColor

indicatorStrokeColor: string = NONE

isDashed

isDashed: boolean = false

isRounded

isRounded: boolean = false

isShadow

isShadow: boolean = false

labelPadding

labelPadding: number

lastValue

lastValue:
    | null
    | string
    | HTMLElement
    | SVGGElement = null

Contains the last rendered text value. Used for caching.

margin

margin: null | Point = null

minSvgStrokeWidth

minSvgStrokeWidth: number = 1

Minimum stroke width for SVG output.

node

node: SVGGElement

Holds the outermost DOM node that represents this shape.

oldGradients

oldGradients: GradientMap = {}

opacity

opacity: number = 100

originalPointerEvents

originalPointerEvents: null | boolean = null

outline

outline: boolean = false

Specifies if the shape should be drawn as an outline. This disables all fill colors and can be used to disable other drawing states that should not be painted for outlines. Default is false. This should be set before calling .

overflow

overflow: OverflowValue

overlay

overlay: null | CellOverlay = null

pointerEvents

pointerEvents: boolean = true

Specifies if pointer events should be handled. Default is true.

points

points: (null | Point)[] = []

Holds the array of that specify the points of this shape.

preserveImageAspect

preserveImageAspect: boolean = false

replaceLinefeeds

replaceLinefeeds: boolean = true

Specifies if linefeeds in HTML labels should be replaced with BR tags. Default is true.

rotation

rotation: number = 0

scale

scale: number = 1

Holds the scale in which the shape is being painted.

shapePointerEvents

shapePointerEvents: boolean = false

Specifies if pointer events outside of shape should be handled. Default is false.

size

size: number

spacing

spacing: number

spacingBottom

spacingBottom: number

spacingLeft

spacingLeft: number

spacingRight

spacingRight: number

spacingTop

spacingTop: number

startArrow

startArrow: string = NONE

startSize

startSize: number = 1

state

state: null | CellState = null

Optional reference to the corresponding .

stencil

stencil: null | StencilShape = null

Holds the StencilShape that defines the shape.

stencilPointerEvents

stencilPointerEvents: boolean = false

Specifies if pointer events outside of stencils should be handled. Default is false. Set this to true for backwards compatibility with the 1.x branch.

stroke

stroke: string = NONE

strokeOpacity

strokeOpacity: number = 100

strokeWidth

strokeWidth: number = 1

style

style: null | CellStateStyle = null

Optional reference to the style of the corresponding .

svgPointerEvents

svgPointerEvents: string = 'all'

Specifies if pointer events should be handled. Default is true.

svgStrokeTolerance

svgStrokeTolerance: number = 8

Event-tolerance for SVG strokes (in px). This is only passed to the canvas in createSvgCanvas if pointerEvents is true.

Default

8

textDirection

textDirection: TextDirectionValue

unrotatedBoundingBox

unrotatedBoundingBox: null | Rectangle = null

useSvgBoundingBox

useSvgBoundingBox: boolean = true

Allows to use the SVG bounding box in SVG. Default is false for performance reasons.

valign

valign: VAlignValue

value

value: string | HTMLElement | SVGGElement

verticalTextRotation

verticalTextRotation: number = -90

Rotation for vertical text. Default is -90 (bottom to top).

visible

visible: boolean = true

Specifies if the shape is visible. Default is true.

wrap

wrap: boolean

Methods

addPoints

  • addPoints(c, pts, rounded?, arcSize, close?, exclude?, initialMove?): void

  • Paints the given points with rounded corners.

    Parameters

    • c: AbstractCanvas2D
    • pts: Point[]
    • rounded: boolean = false
    • arcSize: number
    • close: boolean = false
    • exclude: number[] = []
    • initialMove: boolean = true

    Returns void

afterPaint

apply

augmentBoundingBox

beforePaint

checkBounds

clear

configureCanvas

create

  • create(): SVGGElement

  • Creates and returns the DOM node for the shape. This implementation assumes that maxGraph produces SVG elements.

    Returns SVGGElement

createBoundingBox

createCanvas

createSvgCanvas

createTransparentSvgRectangle

destroy

  • destroy(): void

  • Destroys the shape by removing it from the DOM and releasing the DOM node associated with the shape using Event#release.

    Returns void

destroyCanvas

getArcSize

getAutoDirection

  • getAutoDirection(): LTR | RTL

  • Used to determine the automatic text direction. Returns Constants#TEXT_DIRECTION_LTR or Constants#TEXT_DIRECTION_RTL depending on the contents of . This is not invoked for HTML, wrapped content or if is a DOM node.

    Returns LTR | RTL

getContentNode

getCursor

getGradientBounds

getHtmlValue

getLabelBounds

getLabelMargins

getRotation

getShapeRotation

getSpacing

getSvgScreenOffset

getTextCss

getTextRotation

init

  • init(container): void

  • Initializes the shape by creaing the DOM node using and adding it into the given container.

    Parameters

    • container: HTMLElement | SVGElement

      DOM node that will contain the shape.

    Returns void

initStyles

isHtmlAllowed

isPaintBoundsInverted

isRoundable

paint

paintBackground

paintEdgeShape

paintForeground

paintGlassEffect

paintVertexShape

redraw

redrawHtmlShape

redrawShape

releaseSvgGradients

resetStyles

setCursor

setTransparentBackgroundImage

updateBoundingBox

updateBoundsFromPoints

updateFont

  • updateFont(node): void

  • Updates the HTML node(s) to reflect the latest bounds and scale.

    Parameters

    • node: HTMLElement | SVGGElement

    Returns void

updateInnerHtml

updateMargin

updateSize

  • updateSize(node, enableWrap?): void

  • Updates the HTML node(s) to reflect the latest bounds and scale.

    Parameters

    • node: HTMLElement
    • enableWrap: boolean = false

    Returns void

updateTransform

updateValue

Settings

Member Visibility

On This Page

Constructors
Properties
alignantiAliasbackgroundbaseSpacingBottombaseSpacingLeftbaseSpacingRightbaseSpacingTopborderboundingBoxboundscacheEnabledclippedcolorcursordialectdirectionendArrowendSizefamilyfillfillOpacityflipHflipVfontStyleglassgradientgradientDirectionhorizontalignoreClippedStringSizeignoreStringSizeimageimageSrcindicatorindicatorColorindicatorDirectionindicatorGradientColorindicatorImageSrcindicatorShapeindicatorStrokeColorisDashedisRoundedisShadowlabelPaddinglastValuemarginminSvgStrokeWidthnodeoldGradientsopacityoriginalPointerEventsoutlineoverflowoverlaypointerEventspointspreserveImageAspectreplaceLinefeedsrotationscaleshapePointerEventssizespacingspacingBottomspacingLeftspacingRightspacingTopstartArrowstartSizestatestencilstencilPointerEventsstrokestrokeOpacitystrokeWidthstylesvgPointerEventssvgStrokeTolerancetextDirectionunrotatedBoundingBoxuseSvgBoundingBoxvalignvalueverticalTextRotationvisiblewrap
Methods