@maxgraph/core
    Preparing search index...

    Class ImageShape

    Extends RectangleShape to implement an image shape. This shape is registered by default under SHAPE.IMAGE in CellRenderer.

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    antiAlias boundingBox bounds cursor dialect direction endArrow endSize fill fillOpacity flipH flipV glass gradient gradientDirection image imageSrc indicator indicatorColor indicatorDirection indicatorGradientColor indicatorImageSrc indicatorShape indicatorStrokeColor isDashed isRounded isShadow minSvgStrokeWidth node oldGradients opacity originalPointerEvents outline overlay pointerEvents points preserveImageAspect rotation scale shadow shapePointerEvents spacing startArrow startSize state stencil stencilPointerEvents stroke strokeOpacity strokeWidth style svgPointerEvents svgStrokeTolerance useSvgBoundingBox verticalTextRotation visible

    Methods

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

    Constructors

    Properties

    antiAlias: boolean = true

    Rendering hint for configuring the canvas.

    boundingBox: null | Rectangle = null

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

    bounds: null | Rectangle = null

    Holds the Rectangle that specifies the bounds of this shape.

    cursor: string = ''
    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: DirectionValue = DIRECTION.EAST
    endArrow: string = NONE
    endSize: number = 1
    fill: string = NONE
    fillOpacity: number = 100
    flipH: boolean = false
    flipV: boolean = false
    glass: boolean = false
    gradient: string = NONE
    gradientDirection: DirectionValue = DIRECTION.EAST
    image: null | ImageBox = null
    imageSrc: null | string = null
    indicator: null | Shape = null
    indicatorColor: string = NONE
    indicatorDirection: DirectionValue = DIRECTION.EAST
    indicatorGradientColor: string = NONE
    indicatorImageSrc: null | string = null
    indicatorShape: null | typeof Shape = null
    indicatorStrokeColor: string = NONE
    isDashed: boolean = false
    isRounded: boolean = false
    isShadow: boolean = false
    minSvgStrokeWidth: number = 1

    Minimum stroke width for SVG output.

    node: SVGGElement

    Holds the outermost DOM node that represents this shape.

    oldGradients: GradientMap = {}
    opacity: number = 100
    originalPointerEvents: null | boolean = null
    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 .

    overlay: null | CellOverlay = null
    pointerEvents: boolean = true

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

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

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

    preserveImageAspect: boolean = false

    Switch to preserve image aspect.

    false
    rotation: number = 0
    scale: number = 1

    Holds the scale in which the shape is being painted.

    shadow: boolean
    shapePointerEvents: boolean = false

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

    spacing: number = 0
    startArrow: string = NONE
    startSize: number = 1
    state: null | CellState = null

    Optional reference to the corresponding .

    stencil: null | StencilShape = null

    Holds the StencilShape that defines the shape.

    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: string = NONE
    strokeOpacity: number = 100
    strokeWidth: number = 1
    style: null | CellStateStyle = null

    Optional reference to the style of the corresponding .

    svgPointerEvents: string = 'all'

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

    svgStrokeTolerance: number = 8

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

    8
    useSvgBoundingBox: boolean = true

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

    verticalTextRotation: number = 0
    visible: boolean = true

    Specifies if the shape is visible. Default is true.

    Methods

    • 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

    • Overrides to replace the fill and stroke colors with the respective values from imageBackground and imageBorder.

      Applies the style of the given CellState to the shape. This implementation assigns the following styles to local fields:

      • imageBackground => fill
      • imageBorder => stroke

      Parameters

      Returns 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

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods