mxGraph
Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | Properties | List of all members
com.mxgraph.mxBasicCanvas Class Referenceabstract

Basic implementation of a canvas that draws a graph. More...

Inheritance diagram for com.mxgraph.mxBasicCanvas:
com.mxgraph.mxICanvas com.mxgraph.mxGdiCanvas

Public Member Functions

abstract Object DrawCell (mxCellState state)
 see com.mxgraph.mxICanvas.DrawCell() More...
 
abstract Object DrawLabel (string text, mxCellState state, bool html)
 see com.mxgraph.mxICanvas.DrawLabel() More...
 

Static Public Attributes

static string DEFAULT_IMAGEBASEPATH = ""
 Defines the default value for the imageBasePath in all GDI canvases. Default is an empty string. More...
 

Protected Member Functions

string GetImageForStyle (Dictionary< string, Object > style)
 Gets the image path from the given style. If the path is relative (does not start with a slash) then it is appended to the imageBasePath. More...
 

Protected Attributes

string imageBasePath = DEFAULT_IMAGEBASEPATH
 Defines the base path for images with relative paths. Trailing slash is required. Default value is DEFAULT_IMAGEBASEPATH. More...
 
Point translate = new Point(0, 0)
 Specifies the current translation. Default is (0,0). More...
 
double scale
 Specifies the current scale. Default is 1. More...
 
bool drawLabels = true
 Specifies whether labels should be painted. Default is true. More...
 

Properties

Point Translate [get, set]
 see com.mxgraph.mxICanvas.Translate More...
 
double Scale [get, set]
 see com.mxgraph.mxICanvas.Scale More...
 
bool DrawLabels [get, set]
 Sets if labels should be visible. More...
 
string ImageBasePath [get, set]
 Sets or gets the image base path. More...
 
- Properties inherited from com.mxgraph.mxICanvas
Point Translate [get, set]
 Sets or returns the user object of the cell. More...
 
double Scale [get, set]
 Sets or returns the user object of the cell. More...
 

Detailed Description

Basic implementation of a canvas that draws a graph.

Member Function Documentation

◆ DrawCell()

abstract Object com.mxgraph.mxBasicCanvas.DrawCell ( mxCellState  state)
pure virtual

◆ DrawLabel()

abstract Object com.mxgraph.mxBasicCanvas.DrawLabel ( string  text,
mxCellState  state,
bool  html 
)
pure virtual

◆ GetImageForStyle()

string com.mxgraph.mxBasicCanvas.GetImageForStyle ( Dictionary< string, Object >  style)
inlineprotected

Gets the image path from the given style. If the path is relative (does not start with a slash) then it is appended to the imageBasePath.

Parameters
style
Returns

References com.mxgraph.mxUtils.GetString(), and com.mxgraph.mxConstants.STYLE_IMAGE.

Member Data Documentation

◆ DEFAULT_IMAGEBASEPATH

string com.mxgraph.mxBasicCanvas.DEFAULT_IMAGEBASEPATH = ""
static

Defines the default value for the imageBasePath in all GDI canvases. Default is an empty string.

◆ drawLabels

bool com.mxgraph.mxBasicCanvas.drawLabels = true
protected

Specifies whether labels should be painted. Default is true.

◆ imageBasePath

string com.mxgraph.mxBasicCanvas.imageBasePath = DEFAULT_IMAGEBASEPATH
protected

Defines the base path for images with relative paths. Trailing slash is required. Default value is DEFAULT_IMAGEBASEPATH.

◆ scale

double com.mxgraph.mxBasicCanvas.scale
protected

Specifies the current scale. Default is 1.

◆ translate

Point com.mxgraph.mxBasicCanvas.translate = new Point(0, 0)
protected

Specifies the current translation. Default is (0,0).

Property Documentation

◆ DrawLabels

bool com.mxgraph.mxBasicCanvas.DrawLabels
getset

Sets if labels should be visible.

◆ ImageBasePath

string com.mxgraph.mxBasicCanvas.ImageBasePath
getset

Sets or gets the image base path.

◆ Scale

double com.mxgraph.mxBasicCanvas.Scale
getset

◆ Translate

Point com.mxgraph.mxBasicCanvas.Translate
getset

The documentation for this class was generated from the following file: