UNPKG

markgojs

Version:

Interactive diagrams, charts, and graphs, such as trees, flowcharts, orgcharts, UML, BPMN, or business diagrams

2,045 lines • 66.2 kB
<!DOCTYPE html>
<html>
    <head>
        <meta charset="utf-8">
        <meta name="viewport" content="width=device-width, initial-scale=1">
        <title>GoJS&reg; Brush Class</title>
        
        <script src="../../assets/js/jquery.min.js"></script>
    <script src="../../assets/js/bootstrap.min.js"></script>
    <script src="../../assets/js/highlight.js"></script>
    <script src="../../assets/js/api.js"></script>
    <script src="../../assets/js/fuse.min.js"></script>

    <link href="../../assets/css/bootstrap.min.css" rel="stylesheet" >
    <!-- custom CSS after bootstrap -->
    <link href="../../assets/css/main.css" rel="stylesheet" type="text/css"/>
    <link href="../../assets/css/api.css" rel="stylesheet" type="text/css"/>
    <!--<link rel="stylesheet" href="../../assets/css/api.css" type="text/css" media="all" />-->
    <link rel="stylesheet" href="../../assets/css/highlight.css" type="text/css" media="all" />

    </head>

    <body>
    <!-- non-fixed navbar -->
<nav id="non-fixed-nav" class="navbar navbar-inverse navbar-top">
  <div class="container-fluid">
    <div class="navbar-header">
      <div class="navheader-container">
        <div class="navheader-collapse" data-toggle="collapse" data-target="#navbar">
          <a id="toplogo" class="navbar-brand" href="../../index.html">GoJS</a>
          <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
            <span class="sr-only">Toggle navigation</span>
            <span class="icon-bar"></span>
            <span class="icon-bar"></span>
            <span class="icon-bar"></span>
          </button>
        </div>
      </div>
    </div>
    <div id="navbar" class="navbar-collapse collapse">
      <ul class="nav navbar-nav navbar-right">
        <li><a href="../../index.html">Home</a></li>
        <li><a href="../../learn/index.html">Learn</a></li>
        <li><a href="../../samples/index.html">Samples</a></li>
        <li><a href="../../intro/index.html">Intro</a></li>
        <li><a href="../../api/index.html">API</a></li>
        <li><a href="https://www.nwoods.com/components/evalform.htm">Register</a></li>
        <li><a href="../../download.html">Download</a></li>
        <li><a href="https://forum.nwoods.com/c/gojs">Forum</a></li>
        <li><a href="https://www.nwoods.com/contact.html" onclick="ga('send','event','Outbound Link','click','contact');">Contact</a></li>
        <li class="buy"><a href="https://www.nwoods.com/sales/index.html" onclick="ga('send','event','Outbound Link','click','buy');">Buy</a></li>
        <li class="activate"><a href="https://www.nwoods.com/app/activate.aspx?sku=gojs">Activate</a></li>
      </ul>
    </div><!--/.nav-collapse -->
  </div>
</nav>


    <div class="container-fluid">

<!-- ============================== classes index ============================ -->
     <div id="navindex" class="col-md-2">
        <!-- begin publish.classesIndex -->
        <!-- <div><a href="../index.html">GoJS Class Index</a></div> -->

<div class="sidebar-nav">
  <div class="navbar navbar-default" role="navigation">
    <div class="navbar-header">
      <div class="navheader-container">
        <div class="navheader-collapse" data-toggle="collapse" data-target="#DiagramNavbar">
          <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#DiagramNavbar">
            <span class="sr-only">Toggle navigation</span>
            <span class="icon-bar"></span>
            <span class="icon-bar"></span>
            <span class="icon-bar"></span>
          </button>
        </div>
        <span class="navbar-brand">Diagram Classes</span>
      </div>
    </div>
    <div id="DiagramNavbar" class="navbar-collapse collapse sidebar-navbar-collapse">
    <ul class="classList nav navbar-nav">
      
        
      
        
      
        <li><a href="../symbols/Adornment.html" class="linkConstructor">Adornment</a></li>
      
        <li><a href="../symbols/AnimationManager.html" class="linkConstructor">AnimationManager</a></li>
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        <li><a href="../symbols/CommandHandler.html" class="linkConstructor">CommandHandler</a></li>
      
        
      
        <li><a href="../symbols/Diagram.html" class="linkConstructor">Diagram</a></li>
      
        <li><a href="../symbols/DiagramEvent.html" class="linkConstructor">DiagramEvent</a></li>
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        <li><a href="../symbols/GraphObject.html" class="linkConstructor">GraphObject</a></li>
      
        
      
        <li><a href="../symbols/Group.html" class="linkConstructor">Group</a></li>
      
        
      
        <li><a href="../symbols/InputEvent.html" class="linkConstructor">InputEvent</a></li>
      
        
      
        
      
        <li><a href="../symbols/Layer.html" class="linkConstructor">Layer</a></li>
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        <li><a href="../symbols/Link.html" class="linkConstructor">Link</a></li>
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        <li><a href="../symbols/Node.html" class="linkConstructor">Node</a></li>
      
        <li><a href="../symbols/Overview.html" class="linkConstructor">Overview</a></li>
      
        <li><a href="../symbols/Palette.html" class="linkConstructor">Palette</a></li>
      
        <li><a href="../symbols/Panel.html" class="linkConstructor">Panel</a></li>
      
        
      
        <li><a href="../symbols/Part.html" class="linkConstructor">Part</a></li>
      
        
      
        
      
        <li><a href="../symbols/Picture.html" class="linkConstructor">Picture</a></li>
      
        <li><a href="../symbols/Placeholder.html" class="linkConstructor">Placeholder</a></li>
      
        
      
        
      
        
      
        
      
        
      
        <li><a href="../symbols/RowColumnDefinition.html" class="linkConstructor">RowColumnDefinition</a></li>
      
        
      
        <li><a href="../symbols/Shape.html" class="linkConstructor">Shape</a></li>
      
        
      
        
      
        <li><a href="../symbols/TextBlock.html" class="linkConstructor">TextBlock</a></li>
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
    </ul>
    </div>
  </div>

  <div class="navbar navbar-default" role="navigation">
    <div class="navbar-header">
      <div class="navheader-container">
        <div class="navheader-collapse" data-toggle="collapse" data-target="#GeometryNavbar">
          <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#GeometryNavbar">
            <span class="sr-only">Toggle navigation</span>
            <span class="icon-bar"></span>
            <span class="icon-bar"></span>
            <span class="icon-bar"></span>
          </button>
        </div>
        <span class="navbar-brand">Geometry Classes</span>
      </div>
    </div>
    <div id="GeometryNavbar" class="navbar-collapse collapse sidebar-navbar-collapse">
    <ul class="classList nav navbar-nav">
      
        
      
        
      
        
      
        
      
        
      
        <li><a href="../symbols/Brush.html" class="linkConstructor">Brush</a></li>
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        <li><a href="../symbols/Geometry.html" class="linkConstructor">Geometry</a></li>
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        <li><a href="../symbols/Margin.html" class="linkConstructor">Margin</a></li>
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        <li><a href="../symbols/PathFigure.html" class="linkConstructor">PathFigure</a></li>
      
        <li><a href="../symbols/PathSegment.html" class="linkConstructor">PathSegment</a></li>
      
        
      
        
      
        <li><a href="../symbols/Point.html" class="linkConstructor">Point</a></li>
      
        <li><a href="../symbols/Rect.html" class="linkConstructor">Rect</a></li>
      
        
      
        
      
        
      
        
      
        
      
        
      
        <li><a href="../symbols/Size.html" class="linkConstructor">Size</a></li>
      
        <li><a href="../symbols/Spot.html" class="linkConstructor">Spot</a></li>
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
    </ul>
    </div>
  </div>

  <div class="navbar navbar-default" role="navigation">
    <div class="navbar-header">
      <div class="navheader-container">
        <div class="navheader-collapse" data-toggle="collapse" data-target="#ModelNavbar">
          <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#ModelNavbar">
            <span class="sr-only">Toggle navigation</span>
            <span class="icon-bar"></span>
            <span class="icon-bar"></span>
            <span class="icon-bar"></span>
          </button>
        </div>
        <span class="navbar-brand">Model Classes</span>
      </div>
    </div>
    <div id="ModelNavbar" class="navbar-collapse collapse sidebar-navbar-collapse">
    <ul class="classList nav navbar-nav">
      
        
      
        
      
        
      
        
      
        <li><a href="../symbols/Binding.html" class="linkConstructor">Binding</a></li>
      
        
      
        <li><a href="../symbols/ChangedEvent.html" class="linkConstructor">ChangedEvent</a></li>
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        <li><a href="../symbols/GraphLinksModel.html" class="linkConstructor">GraphLinksModel</a></li>
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        <li><a href="../symbols/Model.html" class="linkConstructor">Model</a></li>
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        <li><a href="../symbols/Transaction.html" class="linkConstructor">Transaction</a></li>
      
        
      
        
      
        <li><a href="../symbols/TreeModel.html" class="linkConstructor">TreeModel</a></li>
      
        
      
        
      
        <li><a href="../symbols/UndoManager.html" class="linkConstructor">UndoManager</a></li>
      
    </ul>
    </div>
  </div>

  <div class="navbar navbar-default" role="navigation">
    <div class="navbar-header">
      <div class="navheader-container">
        <div class="navheader-collapse" data-toggle="collapse" data-target="#LayoutNavbar">
          <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#LayoutNavbar">
            <span class="sr-only">Toggle navigation</span>
            <span class="icon-bar"></span>
            <span class="icon-bar"></span>
            <span class="icon-bar"></span>
          </button>
        </div>
        <span class="navbar-brand">Layout Classes</span>
      </div>
    </div>
    <div id="LayoutNavbar" class="navbar-collapse collapse sidebar-navbar-collapse">
    <ul class="classList nav navbar-nav">
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        <li><a href="../symbols/CircularLayout.html" class="linkConstructor">CircularLayout</a></li>
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        <li><a href="../symbols/ForceDirectedLayout.html" class="linkConstructor">ForceDirectedLayout</a></li>
      
        
      
        
      
        
      
        
      
        
      
        <li><a href="../symbols/GridLayout.html" class="linkConstructor">GridLayout</a></li>
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        <li><a href="../symbols/LayeredDigraphLayout.html" class="linkConstructor">LayeredDigraphLayout</a></li>
      
        
      
        
      
        <li><a href="../symbols/Layout.html" class="linkConstructor">Layout</a></li>
      
        
      
        <li><a href="../symbols/LayoutNetwork.html" class="linkConstructor">LayoutNetwork</a></li>
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        <li><a href="../symbols/TreeLayout.html" class="linkConstructor">TreeLayout</a></li>
      
        
      
        
      
        
      
        
      
    </ul>
    </div>
  </div>

  <div class="navbar navbar-default" role="navigation">
    <div class="navbar-header">
      <div class="navheader-container">
        <div class="navheader-collapse" data-toggle="collapse" data-target="#ToolNavbar">
          <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#ToolNavbar">
            <span class="sr-only">Toggle navigation</span>
            <span class="icon-bar"></span>
            <span class="icon-bar"></span>
            <span class="icon-bar"></span>
          </button>
        </div>
        <span class="navbar-brand">Tool Classes</span>
      </div>
    </div>
    <div id="ToolNavbar" class="navbar-collapse collapse sidebar-navbar-collapse">
    <ul class="classList nav navbar-nav">
      
        
      
        <li><a href="../symbols/ActionTool.html" class="linkConstructor">ActionTool</a></li>
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        <li><a href="../symbols/ClickCreatingTool.html" class="linkConstructor">ClickCreatingTool</a></li>
      
        <li><a href="../symbols/ClickSelectingTool.html" class="linkConstructor">ClickSelectingTool</a></li>
      
        
      
        <li><a href="../symbols/ContextMenuTool.html" class="linkConstructor">ContextMenuTool</a></li>
      
        
      
        
      
        <li><a href="../symbols/DraggingTool.html" class="linkConstructor">DraggingTool</a></li>
      
        <li><a href="../symbols/DragSelectingTool.html" class="linkConstructor">DragSelectingTool</a></li>
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        <li><a href="../symbols/HTMLInfo.html" class="linkConstructor">HTMLInfo</a></li>
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        <li><a href="../symbols/LinkingBaseTool.html" class="linkConstructor">LinkingBaseTool</a></li>
      
        <li><a href="../symbols/LinkingTool.html" class="linkConstructor">LinkingTool</a></li>
      
        <li><a href="../symbols/LinkReshapingTool.html" class="linkConstructor">LinkReshapingTool</a></li>
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        <li><a href="../symbols/PanningTool.html" class="linkConstructor">PanningTool</a></li>
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        <li><a href="../symbols/RelinkingTool.html" class="linkConstructor">RelinkingTool</a></li>
      
        <li><a href="../symbols/ResizingTool.html" class="linkConstructor">ResizingTool</a></li>
      
        <li><a href="../symbols/RotatingTool.html" class="linkConstructor">RotatingTool</a></li>
      
        
      
        
      
        
      
        
      
        
      
        
      
        <li><a href="../symbols/TextEditingTool.html" class="linkConstructor">TextEditingTool</a></li>
      
        <li><a href="../symbols/Tool.html" class="linkConstructor">Tool</a></li>
      
        <li><a href="../symbols/ToolManager.html" class="linkConstructor">ToolManager</a></li>
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
    </ul>
    </div>
  </div>

  <div class="navbar navbar-default" role="navigation">
    <div class="navbar-header">
      <div class="navheader-container">
        <div class="navheader-collapse" data-toggle="collapse" data-target="#CollectionNavbar">
          <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#CollectionNavbar">
            <span class="sr-only">Toggle navigation</span>
            <span class="icon-bar"></span>
            <span class="icon-bar"></span>
            <span class="icon-bar"></span>
          </button>
        </div>
        <span class="navbar-brand">Collection Classes</span>
      </div>
    </div>
    <div id="CollectionNavbar" class="navbar-collapse collapse sidebar-navbar-collapse">
    <ul class="classList nav navbar-nav">
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        <li><a href="../symbols/Iterable.html" class="linkConstructor">Iterable</a></li>
      
        <li><a href="../symbols/Iterator.html" class="linkConstructor">Iterator</a></li>
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        <li><a href="../symbols/List.html" class="linkConstructor">List</a></li>
      
        <li><a href="../symbols/Map.html" class="linkConstructor">Map</a></li>
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        <li><a href="../symbols/Set.html" class="linkConstructor">Set</a></li>
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
        
      
    </ul>
    </div>
  </div>
</div> <!-- /class="sidebar-nav -->




        <!-- end publish.classesIndex -->
    </div>

    <div id="contentBody" class="col-md-10">

        <div class="searchsumm">
            <div class="table-wrap">
                <div class="table-cell" id="apisearch" data-base="../">
                    <div class="title">Search API</div>
                    <div class="field">
                        <label for="search-field" class="search-icon"></label>
                        <input id="search-field" type="text" />
                    </div>
                    <ul class="results">
                        <li class="state loading">Preparing search index...</li>
                        <li class="state failure">The search index is not available</li>
                    </ul>
                </div>
                <div class="table-cell" id="apisumm">
                    <input type="checkbox" id="showsumms" />
                    <label class="apisumms" for="showsumms">Show Summaries</label>
                </div>
            </div>
        </div>

    <!-- ============================== header ================================= -->
    <div id="header" class="fineprint">
      <b>GoJS</b>&reg; Diagramming Components<br/>version 1.8.36 for JavaScript/HTML<br/>by <a href="https://www.nwoods.com/">Northwoods Software&reg;</a>
    </div>

<!-- ============================== class title ============================ -->
            <h2 class="classTitle">
                
                Class Brush
                
            </h2>

<!-- ============================== class summary ========================== -->
            <p class="classsummary">
                
                

                A Brush holds color information and describes how to draw the inside
of a <a href="../symbols/Shape.html" class="linkConstructor">Shape</a> or the stroke of a shape or a <a href="../symbols/TextBlock.html" class="linkConstructor">TextBlock</a> or the
background of any <a href="../symbols/GraphObject.html" class="linkConstructor">GraphObject</a>.
<p>
A Brush must not be modified once it has been assigned to a <a href="../symbols/GraphObject.html" class="linkConstructor">GraphObject</a>,
such as the <a href="../symbols/Shape.html#fill" class="linkProperty">Shape.fill</a> or <a href="../symbols/TextBlock.html#stroke" class="linkProperty">TextBlock.stroke</a>
or <a href="../symbols/GraphObject.html#background" class="linkProperty">GraphObject.background</a>.
However, a Brush may be shared by multiple GraphObjects.
            </p>

<!-- ============================== constructor summary ==================== -->
            
        <h2 id="constructor" class="summaryCaption"> Constructor <span class="nodetails"> Summary</span><span class="details"> Details</span></h2>
            <div class="table-responsive">
            <table class="summaryTable table table-bordered table-condensed" summary="A summary of the constructor documented in the class Brush.">
                <thead>
                        <tr>
                            <th scope="col" class="name">Name</th>
                            <th scope="col" class="description">Description</th>
                        </tr>
                </thead>
                <tbody>
                    <tr>
                        <td class="name" >
                            <div class="name">
                                Brush(type)
                            </div>
              </td>
              <td class="description">
                            <div class="description">
                            <!--newp--><p><p>Construct a Brush class that holds the given color information.<span class="nodetails" id="xconBrush"><a class="morelink" onclick="hst('conBrush')">More...</a></span> <span class="details" id="conBrush"></span>
                        
                            <dl class="detailList">
                            <dt class="heading">Parameters:</dt>
                            
                                <dt>
                                    <span class="light fixedFont">{EnumValue|string=}</span>  <b>type</b>
                                    
                                </dt>
                                    <dd>Optional,
one of the values <a href="../symbols/Brush.html#Solid" class="linkConstant">Brush.Solid</a>, <a href="../symbols/Brush.html#Linear" class="linkConstant">Brush.Linear</a>, <a href="../symbols/Brush.html#Radial" class="linkConstant">Brush.Radial</a>,
<a href="../symbols/Brush.html#Pattern" class="linkConstant">Brush.Pattern</a>, or a well-formed CSS string describing a solid color brush. No parameter
defaults to a <a href="../symbols/Brush.html#Solid" class="linkConstant">Brush.Solid</a> with a color description of 'black'.</dd>
                            
                            </dl>
                        
                        


              </div>
                        </td>
                    </tr>
                </tbody>
            </table>
            </div><!-- class="table-responsive">-->
            

<!-- ============================== properties summary ===================== -->
            
                
                
        <h2 class="summaryCaption">Properties<span class="nodetails"> Summary</span><span class="details"> Details</span></h2>
        <div class="table-responsive">
        <table class="summaryTable table table-bordered table-condensed" summary="A summary of the properties documented in the class Brush.">
                    <thead>
                        <tr>
                            <th scope="col" class="name">Name, Value Type</th>
                            <th scope="col" class="description">Description</th>
                        </tr>
                    </thead>
                    <tbody>
                    
              <tr id="color" >
                
                <td class="name">
                  <div class="name">
                    color
                  </div>
                  <div class="attributes">
                    <span class="light">{string}</span>
                    
                  </div>
                </td>
                <td class="description">
                <div class="description">
                <!--newp <p> -->
                <p>Gets or sets the color of a solid Brush.
                
                </div>
                            </td>
                        </tr>
                    
              <tr id="colorStops" >
                
                <td class="name">
                  <div class="name">
                    colorStops
                  </div>
                  <div class="attributes">
                    <span class="light">{Map.<number,string>}</span>
                    
                  </div>
                </td>
                <td class="description">
                <div class="description">
                <!--newp <p> -->
                <p>Gets or sets a Map holding all of the color stops used in this gradient,
where the key is a number, the fractional distance between zero and one (inclusive),
and where the corresponding value is a color string.<span class="nodetails" id="xpropcolorStops"><a class="morelink" onclick="hst('propcolorStops')">More...</a></span> <span class="details" id="propcolorStops">
</span><div class="details" id="dpropcolorStops"><p>
Call <a href="../symbols/Brush.html#addColorStop" class="linkMethod">addColorStop</a> in order to add color stops to this brush.
This property value may be null if no gradient stops have been defined.</div>
                
                </div>
                            </td>
                        </tr>
                    
              <tr id="end" >
                
                <td class="name">
                  <div class="name">
                    end
                  </div>
                  <div class="attributes">
                    <span class="light">{<a href="../symbols/Spot.html" class="linkConstructor">Spot</a>}</span>
                    
                  </div>
                </td>
                <td class="description">
                <div class="description">
                <!--newp <p> -->
                <p>Gets or sets the ending location for a linear or radial gradient.<span class="nodetails" id="xpropend"><a class="morelink" onclick="hst('propend')">More...</a></span> <span class="details" id="propend">
A <a href="../symbols/Spot.html" class="linkConstructor">Spot</a> value specifies a relative point in the object's <a href="../symbols/GraphObject.html#naturalBounds" class="linkProperty">GraphObject.naturalBounds</a>.
This defaults to <a href="../symbols/Spot.html#BottomCenter" class="linkConstant">Spot.BottomCenter</a> for linear gradients and <a href="../symbols/Spot.html#Center" class="linkConstant">Spot.Center</a> for radial gradients.</span>
                
                </div>
                            </td>
                        </tr>
                    
              <tr id="endRadius" >
                
                <td class="name">
                  <div class="name">
                    endRadius
                  </div>
                  <div class="attributes">
                    <span class="light">{number}</span>
                    
                  </div>
                </td>
                <td class="description">
                <div class="description">
                <!--newp <p> -->
                <p>Gets or sets the radius of a radial brush at the end location.<span class="nodetails" id="xpropendRadius"><a class="morelink" onclick="hst('propendRadius')">More...</a></span> <span class="details" id="propendRadius">
The default value is NaN.</span>
                
                </div>
                            </td>
                        </tr>
                    
              <tr id="pattern" >
                
                <td class="name">
                  <div class="name">
                    pattern
                  </div>
                  <div class="attributes">
                    <span class="light">{HTMLCanvasElement|HTMLImageElement}</span>
                    
                  </div>
                </td>
                <td class="description">
                <div class="description">
                <!--newp <p> -->
                <p>Gets or sets the pattern of a brush of type <a href="../symbols/Brush.html#Pattern" class="linkConstant">Brush.Pattern</a>.<span class="nodetails" id="xproppattern"><a class="morelink" onclick="hst('proppattern')">More...</a></span> <span class="details" id="proppattern">
Must be a reference to an HTMLCanvasElement or HTMLImageElement.</span>
                
                </div>
                            </td>
                        </tr>
                    
              <tr id="start" >
                
                <td class="name">
                  <div class="name">
                    start
                  </div>
                  <div class="attributes">
                    <span class="light">{<a href="../symbols/Spot.html" class="linkConstructor">Spot</a>}</span>
                    
                  </div>
                </td>
                <td class="description">
                <div class="description">
                <!--newp <p> -->
                <p>Gets or sets the starting location for a linear or radial gradient.<span class="nodetails" id="xpropstart"><a class="morelink" onclick="hst('propstart')">More...</a></span> <span class="details" id="propstart">
A <a href="../symbols/Spot.html" class="linkConstructor">Spot</a> value specifies a relative point in the object's <a href="../symbols/GraphObject.html#naturalBounds" class="linkProperty">GraphObject.naturalBounds</a>.
This defaults to <a href="../symbols/Spot.html#TopCenter" class="linkConstant">Spot.TopCenter</a> for linear gradients and <a href="../symbols/Spot.html#Center" class="linkConstant">Spot.Center</a> for radial gradients.</span>
                
                </div>
                            </td>
                        </tr>
                    
              <tr id="startRadius" >
                
                <td class="name">
                  <div class="name">
                    startRadius
                  </div>
                  <div class="attributes">
                    <span class="light">{number}</span>
                    
                  </div>
                </td>
                <td class="description">
                <div class="description">
                <!--newp <p> -->
                <p>Gets or sets the radius of a radial brush at the start location.<span class="nodetails" id="xpropstartRadius"><a class="morelink" onclick="hst('propstartRadius')">More...</a></span> <span class="details" id="propstartRadius">
This defaults to zero.</span>
                
                </div>
                            </td>
                        </tr>
                    
              <tr id="type" >
                
                <td class="name">
                  <div class="name">
                    type
                  </div>
                  <div class="attributes">
                    <span class="light">{EnumValue}</span>
                    
                  </div>
                </td>
                <td class="description">
                <div class="description">
                <!--newp <p> -->
                <p>Gets or sets the type of brush.<span class="nodetails" id="xproptype"><a class="morelink" onclick="hst('proptype')">More...</a></span> <span class="details" id="proptype">
The value must be one of: <a href="../symbols/Brush.html#Solid" class="linkConstant">Brush.Solid</a>, <a href="../symbols/Brush.html#Linear" class="linkConstant">Brush.Linear</a>, <a href="../symbols/Brush.html#Radial" class="linkConstant">Brush.Radial</a>, <a href="../symbols/Brush.html#Pattern" class="linkConstant">Brush.Pattern</a>.
If the new value is a linear or radial brush type,
and if the <a href="../symbols/Brush.html#start" class="linkProperty">start</a> or <a href="../symbols/Brush.html#end" class="linkProperty">end</a> spots are not specific spots,
they are changed to be specific spots, depending on the type of brush.</span>
                
                </div>
                            </td>
                        </tr>
                    
                    </tbody>
                </table>
                </div><!-- class="table-responsive">-->
                

                
            

<!-- ============================== methods summary ======================== -->
            
                
                
        <h2 class="summaryCaption">Method <span class="nodetails"> Summary</span><span class="details"> Details</span></h2>
                <div class="table-responsive">
                <table class="summaryTable table table-bordered table-condensed" summary="A summary of the methods documented in the class Brush.">
                    <thead>
                        <tr>
                            <th scope="col" class="name">Name, Return Type</th>
                            <th scope="col" class="description">Description</th>
                        </tr>
                    </thead>
                    <tbody>
                    
            <tr id="addColorStop">
                <td class="name">
                  
                  <div class="name">
                    addColorStop(loc, color)
                  </div>
                  <div class="attributes">
                    
                    
                  </div>
                </td>
                <td class="description">
                                <div class="description">
                                <!--newp--><p><p>Specify a particular color at a particular fraction of the distance.<span class="nodetails" id="xmethaddColorStop"><a class="morelink" onclick="hst('methaddColorStop')">More...</a></span> <span class="details" id="methaddColorStop">
If the <a href="../symbols/Brush.html#type" class="linkProperty">type</a> is <a href="../symbols/Brush.html#Solid" class="linkConstant">Brush.Solid</a>, change the type to <a href="../symbols/Brush.html#Linear" class="linkConstant">Brush.Linear</a>.
You should have a color stop at zero and a color stop at one.
You should not have duplicate color stop values at the same fractional distance.</span>
                 
                              
                                  <dl class="detailList">
                                  <dt class="heading">Parameters:</dt>
                                  
                                      <dt>
                                          <span class="light fixedFont">{number}</span> <b>loc</b>
                                          
                                      </dt>
                                      <dd>between zero and one, inclusive.</dd>
                                  
                                      <dt>
                                          <span class="light fixedFont">{string}</span> <b>color</b>
                                          
                                      </dt>
                                      <dd></dd>
                                  
                                  </dl>
                              
                              

                </div>
                            </td>
                        </tr>
                    
            <tr id="copy">
                <td class="name">
                  
                  <div class="name">
                    copy()
                  </div>
                  <div class="attributes">
                    <span class="light">{<a href="../symbols/Brush.html" class="linkConstructor">Brush</a>}</span>
                    
                  </div>
                </td>
                <td class="description">
                                <div class="description">
                                <!--newp--><p><p>Create a copy of this Brush, with the same values.
                 
                              
                              
                                  <dl class="detailList">
                                  <dt class="heading">Returns:</dt>
                                  
                                      <dt><span class="light fixedFont">{<a href="../symbols/Brush.html" class="linkConstructor">Brush</a>}</span> </dt>
                                  
                                  </dl>
                              

                </div>
                            </td>
                        </tr>
                    
            <tr id=".darken">
                <td class="name">
                  &lt;static&gt; 
                  <div class="name">
                    Brush.darken(color)
                  </div>
                  <div class="attributes">
                    <span class="light">{string}</span>
                    
                      <span class="since" title="since">1.7</span>
                    
                  </div>
                </td>
                <td class="description">
                                <div class="description">
                                <!--newp--><p><p>This static function takes a color and darkens it by 20% in the Lab color space.<span class="nodetails" id="xmethdarken"><a class="morelink" onclick="hst('methdarken')">More...</a></span> <span class="details" id="methdarken">
This is a convenience function which calls <a href="../symbols/Brush.html#.darkenBy" class="linkStatic">Brush.darkenBy</a>.</span>
                 
                              
                                  <dl class="detailList">
                                  <dt class="heading">Parameters:</dt>
                                  
                                      <dt>
                                          <span class="light fixedFont">{string}</span> <b>color</b>
                                          
                                      </dt>
                                      <dd>a valid CSS color string</dd>
                                  
                                  </dl>
                              
                              
                                  <dl class="detailList">
                                  <dt class="heading">Returns:</dt>
                                  
                                      <dt><span class="light fixedFont">{string}</span> a CSS string for the darkened color in RGBA</dt>
                                  
                                  </dl>
                              

                </div>
                            </td>
                        </tr>
                    
            <tr id="darkenBy">
                <td class="name">
                  
                  <div class="name">
                    darkenBy(fraction, mode)
                  </div>
                  <div class="attributes">
                    <span class="light">{<a href="../symbols/Brush.html" class="linkConstructor">Brush</a>}</span>
                    
                      <span class="since" title="since">1.7</span>
                    
                  </div>
                </td>
                <td class="description">
                                <div class="description">
                                <!--newp--><p><p>Modifies all colors within this Brush, darkening them by some fraction.<span class="nodetails" id="xmethdarkenBy"><a class="morelink" onclick="hst('methdarkenBy')">More...</a></span> <span class="details" id="methdarkenBy"></span>
                 
                              
                                  <dl class="detailList">
                                  <dt class="heading">Parameters:</dt>
                                  
                                      <dt>
                                          <span class="light fixedFont">{number=}</span> <b>fraction</b>
                                          
                                      </dt>
                                      <dd>to darken the colors, defaults to 0.2, must be between zero and one</dd>
                                  
                                      <dt>
                                          <span class="light fixedFont">{EnumValue=}</span> <b>mode</b>
                                          
                                      </dt>
                                      <dd>color space to use for adjusting; can be <a href="../symbols/Brush.html#Lab" class="linkConstant">Brush.Lab</a> or <a href="../symbols/Brush.html#HSL" class="linkConstant">Brush.HSL</a>, defaults to <a href="../symbols/Brush.html#Lab" class="linkConstant">Brush.Lab</a></dd>
                                  
                                  </dl>
                              
                              
                                  <dl class="detailList">
                                  <dt class="heading">Returns:</dt>
                                  
                                      <dt><span class="light fixedFont">{<a href="../symbols/Brush.html" class="linkConstructor">Brush</a>}</span> this Brush with modified color values</dt>
                                  
                                  </dl>
                              

                </div>
                            </td>
                        </tr>
                    
            <tr id=".darkenBy">
                <td class="name">
                  &lt;static&gt; 
                  <div class="name">
                    Brush.darkenBy(color, fraction, mode)
                  </div>
                  <div class="attributes">
                    <span class="light">{string}</span>
                    
                      <span class="since" title="since">1.7</span>
                    
                  </div>
                </td>
                <td class="description">
                                <div class="description">
                                <!--newp--><p><p>This static function takes a color and darkens it.<span class="nodetails" id="xmethdarkenBy"><a class="morelink" onclick="hst('methdarkenBy')">More...</a></span> <span class="details" id="methdarkenBy"></span>
                 
                              
                                  <dl class="detailList">
                                  <dt class="heading">Parameters:</dt>
                                  
                                      <dt>
                                          <span class="light fixedFont">{string}</span> <b>color</b>
                                          
                                      </dt>
                                      <dd>a valid CSS color string</dd>
                                  
                                      <dt>
                                          <span class="light fixedFont">{number=}</span> <b>fraction</b>
                                          
                                      </dt>
                                      <dd>to darken the color, defaults to 0.2, must be between zero and one</dd>
                                  
                                      <dt>
                                          <span class="light fixedFont">{EnumValue=}</span> <b>mode</b>
                                          
                                      </dt>
                                      <dd>color space to use for adjusting; can be <a href="../symbols/Brush.html#Lab" class="linkConstant">Brush.Lab</a> or <a href="../symbols/Brush.html#HSL" class="linkConstant">Brush.HSL</a>, defaults to <a href="../symbols/Brush.html#Lab" class="linkConstant">Brush.Lab</a></dd>
                                  
                                  </dl>
                              
                              
                                  <dl class="detailList">
                                  <dt class="heading">Returns:</dt>
                                  
                                      <dt><span class="light fixedFont">{string}</span> a CSS string for the darkened color in RGBA or HSLA</dt>
                                  
                                  </dl>
                              

                </div>
                            </td>
                        </tr>
                    
            <tr id=".isValidColor">
                <td class="name">
                  &lt;static&gt; 
                  <div class="name">
                    Brush.isValidColor(color)
                  </div>
                  <div class="attributes">
                    <span class="light">{boolean}</span>
                    
                      <span class="since" title="since">1.7</span>
                    
                  </div>
                </td>
                <td class="description">
                                <div class="description">
                                <!--newp--><p><p>This static function returns true if a given color string is well-formed for drawing.<span class="nodetails" id="xmethisValidColor"><a class="morelink" onclick="hst('methisValidColor')">More...</a></span> <span class="details" id="methisValidColor"></span>
                 
                              
                                  <dl class="detailList">
                                  <dt class="heading">Parameters:</dt>
                                  
                                      <dt>
                                          <span class="light fixedFont">{string}</span> <b>color</b>
                                          
                                      </dt>
                                      <dd>A color string to check</dd>
                                  
                                  </dl>
                              
                              
                                  <dl class="detailList">
                                  <dt class="heading">Returns:</dt>
                                  
                                      <dt><span class="light fixedFont">{boolean}</span> </dt>
                                  
                                  </dl>
                              

                </div>
                            </td>
                        </tr>
                    
            <tr id=".lighten">
                <td class="name">
                  &lt;static&gt; 
                  <div class="name">
                    Brush.lighten(color)
                  </div>
                  <div class="attributes">
                    <span class="light">{string}</span>
                    
                      <span class="since" title="since">1.7</span>
                    
                  </div>
                </td>
                <td class="description">
                                <div class="description">
                                <!--newp--><p><p>This static function takes a color and lightens it by 20% in the Lab color space.<span class="nodetails" id="xmethlighten"><a class="morelink" onclick="hst('methlighten')">More...</a></span> <span class="details" id="methlighten">
This is a convenience function which calls <a href="../symbols/Brush.html#.lightenBy" class="linkStatic">Brush.lightenBy</a>.</span>
                 
                              
                                  <dl class="detailList">
                                  <dt class="heading">Parameters:</dt>
                                  
                                      <dt>
                                          <span class="light fixedFont">{string}</span> <b>color</b>
                                          
                                      </dt>
                                      <dd>a valid CSS color string</dd>
                                  
                                  </dl>
                              
                              
                                  <dl class="detailList">
                                  <dt class="heading">Returns:</dt>
                                  
                                      <dt><span class="light fixedFont">{string}</span> a CSS string for the lightened color in RGBA</dt>
                                  
                                  </dl>
                              

                </div>
                            </td>
                        </tr>
                    
            <tr id=".lightenBy">
                <td class="name">
                  &lt;static&gt; 
                  <div class="name">
                    Brush.lightenBy(color, fraction, mode)
                  </div>
                  <div class="attributes">
                    <span class="light">{string}</span>
                    
                      <span class="since" title="since">1.7</span>
                    
                  </div>
                </td>
                <td class="description">
                                <div class="description">
                                <!--newp--><p><p>This static function takes a color and lightens it.<span class="nodetails" id="xmethlightenBy"><a class="morelink" onclick="hst('methlightenBy')">More...</a></span> <span class="details" id="methlightenBy"></span>
                 
                              
                                  <dl class="detailList">
                                  <dt class="heading">Parameters:</dt>
                                  
                                      <dt>
                                          <span class="light fixedFont">{string}</span> <b>color</b>
                                          
                                      </dt>
                                      <dd>a valid CSS color string</dd>
                                  
                                      <dt>
                                          <span class="light fixedFont">{number=}</span> <b>fraction</b>
                                          
                                      </dt>
                                      <dd>to lighten the color, defaults to 0.2, must be between zero and one</dd>
                                  
                                      <dt>
                                          <span class="light fixedFont">{EnumValue=}</span> <b>mode</b>
                                          
                                      </dt>
                                      <dd>color space to use for adjusting; can be <a href="../symbols/Brush.html#Lab" class="linkConstant">Brush.Lab</a> or <a href="../symbols/Brush.html#HSL" class="linkConstant">Brush.HSL</a>, defaults to <a href="../symbols/Brush.html#Lab" class="linkConstant">Brush.Lab</a></dd>
                                  
                                  </dl>
                              
                              
                                  <dl class="detailList">
                                  <dt class="heading">Returns:</dt>
                                  
                                      <dt><span class="light fixedFont">{string}</span> a CSS string for the lightened color in RGBA or HSLA</dt>
                                  
                                  </dl>
                              

                </div>
                            </td>
                        </tr>
                    
            <tr id="lightenBy">
                <td class="name">
                  
                  <div class="name">
                    lightenBy(fraction, mode)
                  </div>
                  <div class="attributes">
                    <span class="light">{<a href="../symbols/Brush.html" class="linkConstructor">Brush</a>}</span>
                    
                      <span class="since" title="since">1.7</span>
                    
                  </div>
                </td>
                <td class="description">
                                <div class="description">
                                <!--newp--><p><p>Modifies all colors within this Brush, lightening them by some fraction.<span class="nodetails" id="xmethlightenBy"><a class="morelink" onclick="hst('methlightenBy')">More...</a></span> <span class="details" id="methlightenBy"></span>
                 
                              
                                  <dl class="detailList">
                                  <dt class="heading">Parameters:</dt>
                                  
                                      <dt>
                                          <span class="light fixedFont">{number=}</span> <b>fraction</b>
                                          
                                      </dt>
                                      <dd>to lighten the colors, defaults to 0.2, must be between zero and one</dd>
                                  
                                      <dt>
                                          <span class="light fixedFont">{EnumValue=}</span> <b>mode</b>
                                          
                                      </dt>
                                      <dd>color space to use for adjusting; can be <a href="../symbols/Brush.html#Lab" class="linkConstant">Brush.Lab</a> or <a href="../symbols/Brush.html#HSL" class="linkConstant">Brush.HSL</a>, defaults to <a href="../symbols/Brush.html#Lab" class="linkConstant">Brush.Lab</a></dd>
                                  
                                  </dl>
                              
                              
                                  <dl class="detailList">
                                  <dt class="heading">Returns:</dt>
                                  
                                      <dt><span class="light fixedFont">{<a href="../symbols/Brush.html" class="linkConstructor">Brush</a>}</span> this Brush with modified color values</dt>
                                  
                                  </dl>
                              

                </div>
                            </td>
                        </tr>
                    
            <tr id=".randomColor">
                <td class="name">
                  &lt;static&gt; 
                  <div class="name">
                    Brush.randomColor(min, max)
                  </div>
                  <div class="attributes">
                    <span class="light">{string}</span>
                    
                  </div>
                </td>
                <td class="description">
                                <div class="description">
                                <!--newp--><p><p>This static function can be used to generate a random color.<span class="nodetails" id="xmethrandomColor"><a class="morelink" onclick="hst('methrandomColor')">More...</a></span> <span class="details" id="methrandomColor"></span>
                 
                              
                                  <dl class="detailList">
                                  <dt class="heading">Parameters:</dt>
                                  
                                      <dt>
                                          <span class="light fixedFont">{number=}</span> <b>min</b>
                                          
                                      </dt>
                                      <dd>a number between zero and 255, defaults to 128.</dd>
                                  
                                      <dt>
                                          <span class="light fixedFont">{number=}</span> <b>max</b>
                                          
                                      </dt>
                                      <dd>a number between zero and 255, defaults to 255.</dd>
                                  
                                  </dl>
                              
                              
                                  <dl class="detailList">
                                  <dt class="heading">Returns:</dt>
                                  
                                      <dt><span class="light fixedFont">{string}</span> a color value in # hexadecimal format.</dt>
                                  
                                  </dl>
                              

                </div>
                            </td>
                        </tr>
                    
                    </tbody>
                </table>
                </div><!-- class="table-responsive">-->
                

                
            
<!-- ============================== events summary ======================== -->
            

<!-- ============================== fields summary ===================== -->
            
                
                
                <h2 class="summaryCaption">Constants<span class="nodetails"> Summary</span><span class="details"> Details</span></h2>
                <div class="table-responsive">
                <table class="summaryTable table table-bordered table-condensed" summary="A summary of the properties documented in the class Brush.">
                    <thead>
                        <tr>
                            <th scope="col" class="name">Name</th>
                            <th scope="col" class="description">Description</th>
                        </tr>
                    </thead>
                    <tbody>
                    
                        <tr id="HSL">
                            <td class="name">
                                <div class="name">
                                HSL
                                
                                
                                    <span class="light">{EnumValue}</span>
                                
                                </div>
               </td>
                <td class="description">
                                <div class="description">
                                <!--newp--><p><p>For lightening and darkening, used as a color-space value.
                            

                </div>
                            </td>
                        </tr>
                    
                        <tr id="Lab">
                            <td class="name">
                                <div class="name">
                                Lab
                                
                                
                                    <span class="light">{EnumValue}</span>
                                
                                </div>
               </td>
                <td class="description">
                                <div class="description">
                                <!--newp--><p><p>For lightening and darkening, used as a color-space value.
                            

                </div>
                            </td>
                        </tr>
                    
                        <tr id="Linear">
                            <td class="name">
                                <div class="name">
                                Linear
                                
                                
                                    <span class="light">{EnumValue}</span>
                                
                                </div>
               </td>
                <td class="description">
                                <div class="description">
                                <!--newp--><p><p>For linear gradient brushes, used as the value for <a href="../symbols/Brush.html#type" class="linkProperty">Brush.type</a>.
                            

                </div>
                            </td>
                        </tr>
                    
                        <tr id="Pattern">
                            <td class="name">
                                <div class="name">
                                Pattern
                                
                                
                                    <span class="light">{EnumValue}</span>
                                
                                </div>
               </td>
                <td class="description">
                                <div class="description">
                                <!--newp--><p><p>For pattern brushes, used as the value for <a href="../symbols/Brush.html#type" class="linkProperty">Brush.type</a>.
                            

                </div>
                            </td>
                        </tr>
                    
                        <tr id="Radial">
                            <td class="name">
                                <div class="name">
                                Radial
                                
                                
                                    <span class="light">{EnumValue}</span>
                                
                                </div>
               </td>
                <td class="description">
                                <div class="description">
                                <!--newp--><p><p>For radial gradient brushes, used as the value for <a href="../symbols/Brush.html#type" class="linkProperty">Brush.type</a>.
                            

                </div>
                            </td>
                        </tr>
                    
                        <tr id="Solid">
                            <td class="name">
                                <div class="name">
                                Solid
                                
                                
                                    <span class="light">{EnumValue}</span>
                                
                                </div>
               </td>
                <td class="description">
                                <div class="description">
                                <!--newp--><p><p>For simple, solid color brushes, used as the value for <a href="../symbols/Brush.html#type" class="linkProperty">Brush.type</a>.
                            

                </div>
                            </td>
                        </tr>
                    
                    </tbody>
                </table>
                </div><!-- class="table-responsive">-->
                

            

<!-- ============================== constructor details ==================== -->

      </div> <!-- end contentBody -->
    </div> <!-- end container-fluid -->

<!-- ============================== footer ================================= -->
        <div id="footer" class="fineprint" style="clear:both">
            Copyright &copy; 1998-2019 by <a href="https://www.nwoods.com/">Northwoods Software Corporation.</a>
        </div>
    </body>
</html>