mirror of
https://github.com/Hopiu/fabric.js.git
synced 2026-03-18 06:50:27 +00:00
1237 lines
28 KiB
HTML
1237 lines
28 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
|
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
|
<head>
|
|
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
|
|
<meta name="generator" content="JsDoc Toolkit" />
|
|
|
|
<title>JsDoc Reference - fabric.Color</title>
|
|
|
|
<style type="text/css">
|
|
/* default.css */
|
|
body
|
|
{
|
|
font: 12px "Lucida Grande", Tahoma, Arial, Helvetica, sans-serif;
|
|
width: 800px;
|
|
}
|
|
|
|
.header
|
|
{
|
|
clear: both;
|
|
background-color: #ccc;
|
|
padding: 8px;
|
|
}
|
|
|
|
h1
|
|
{
|
|
font-size: 150%;
|
|
font-weight: bold;
|
|
padding: 0;
|
|
margin: 1em 0 0 .3em;
|
|
}
|
|
|
|
hr
|
|
{
|
|
border: none 0;
|
|
border-top: 1px solid #7F8FB1;
|
|
height: 1px;
|
|
}
|
|
|
|
pre.code
|
|
{
|
|
display: block;
|
|
padding: 8px;
|
|
border: 1px dashed #ccc;
|
|
}
|
|
|
|
#index
|
|
{
|
|
margin-top: 24px;
|
|
float: left;
|
|
width: 160px;
|
|
position: absolute;
|
|
left: 8px;
|
|
background-color: #F3F3F3;
|
|
padding: 8px;
|
|
}
|
|
|
|
#content
|
|
{
|
|
margin-left: 190px;
|
|
width: 600px;
|
|
}
|
|
|
|
.classList
|
|
{
|
|
list-style-type: none;
|
|
padding: 0;
|
|
margin: 0 0 0 8px;
|
|
font-family: arial, sans-serif;
|
|
font-size: 1em;
|
|
overflow: auto;
|
|
}
|
|
|
|
.classList li
|
|
{
|
|
padding: 0;
|
|
margin: 0 0 8px 0;
|
|
}
|
|
|
|
.summaryTable { width: 100%; }
|
|
|
|
h1.classTitle
|
|
{
|
|
font-size:170%;
|
|
line-height:130%;
|
|
}
|
|
|
|
h2 { font-size: 110%; }
|
|
caption, div.sectionTitle
|
|
{
|
|
background-color: #7F8FB1;
|
|
color: #fff;
|
|
font-size:130%;
|
|
text-align: left;
|
|
padding: 2px 6px 2px 6px;
|
|
border: 1px #7F8FB1 solid;
|
|
}
|
|
|
|
div.sectionTitle { margin-bottom: 8px; }
|
|
.summaryTable thead { display: none; }
|
|
|
|
.summaryTable td
|
|
{
|
|
vertical-align: top;
|
|
padding: 4px;
|
|
border-bottom: 1px #7F8FB1 solid;
|
|
border-right: 1px #7F8FB1 solid;
|
|
}
|
|
|
|
/*col#summaryAttributes {}*/
|
|
.summaryTable td.attributes
|
|
{
|
|
border-left: 1px #7F8FB1 solid;
|
|
width: 140px;
|
|
text-align: right;
|
|
}
|
|
|
|
td.attributes, .fixedFont
|
|
{
|
|
line-height: 15px;
|
|
color: #002EBE;
|
|
font-family: "Courier New",Courier,monospace;
|
|
font-size: 13px;
|
|
}
|
|
|
|
.summaryTable td.nameDescription
|
|
{
|
|
text-align: left;
|
|
font-size: 13px;
|
|
line-height: 15px;
|
|
}
|
|
|
|
.summaryTable td.nameDescription, .description
|
|
{
|
|
line-height: 15px;
|
|
padding: 4px;
|
|
padding-left: 4px;
|
|
}
|
|
|
|
.summaryTable { margin-bottom: 8px; }
|
|
|
|
ul.inheritsList
|
|
{
|
|
list-style: square;
|
|
margin-left: 20px;
|
|
padding-left: 0;
|
|
}
|
|
|
|
.detailList {
|
|
margin-left: 20px;
|
|
line-height: 15px;
|
|
}
|
|
.detailList dt { margin-left: 20px; }
|
|
|
|
.detailList .heading
|
|
{
|
|
font-weight: bold;
|
|
padding-bottom: 6px;
|
|
margin-left: 0;
|
|
}
|
|
|
|
.light, td.attributes, .light a:link, .light a:visited
|
|
{
|
|
color: #777;
|
|
font-style: italic;
|
|
}
|
|
|
|
.fineprint
|
|
{
|
|
text-align: right;
|
|
font-size: 10px;
|
|
}
|
|
</style>
|
|
</head>
|
|
|
|
<body>
|
|
<!-- ============================== header ================================= -->
|
|
<!-- begin static/header.html -->
|
|
<div id="header">
|
|
</div>
|
|
<!-- end static/header.html -->
|
|
|
|
<!-- ============================== classes index ============================ -->
|
|
<div id="index">
|
|
<!-- begin publish.classesIndex -->
|
|
<div align="center"><a href="../index.html">Class Index</a>
|
|
| <a href="../files.html">File Index</a></div>
|
|
<hr />
|
|
<h2>Classes</h2>
|
|
<ul class="classList">
|
|
|
|
<li><i><a href="../symbols/_global_.html">_global_</a></i></li>
|
|
|
|
<li><a href="../symbols/Array.html">Array</a></li>
|
|
|
|
<li><a href="../symbols/fabric.html">fabric</a></li>
|
|
|
|
<li><a href="../symbols/fabric.Canvas.html">fabric.Canvas</a></li>
|
|
|
|
<li><a href="../symbols/fabric.Canvas%23cache.html">fabric.Canvas#cache</a></li>
|
|
|
|
<li><a href="../symbols/fabric.Circle.html">fabric.Circle</a></li>
|
|
|
|
<li><a href="../symbols/fabric.Color.html">fabric.Color</a></li>
|
|
|
|
<li><a href="../symbols/fabric.Element.html">fabric.Element</a></li>
|
|
|
|
<li><a href="../symbols/fabric.Ellipse.html">fabric.Ellipse</a></li>
|
|
|
|
<li><a href="../symbols/fabric.Gradient.html">fabric.Gradient</a></li>
|
|
|
|
<li><a href="../symbols/fabric.Group.html">fabric.Group</a></li>
|
|
|
|
<li><a href="../symbols/fabric.Image.html">fabric.Image</a></li>
|
|
|
|
<li><a href="../symbols/fabric.Intersection.html">fabric.Intersection</a></li>
|
|
|
|
<li><a href="../symbols/fabric.Line.html">fabric.Line</a></li>
|
|
|
|
<li><a href="../symbols/fabric.Object.html">fabric.Object</a></li>
|
|
|
|
<li><a href="../symbols/fabric.Path.html">fabric.Path</a></li>
|
|
|
|
<li><a href="../symbols/fabric.PathGroup.html">fabric.PathGroup</a></li>
|
|
|
|
<li><a href="../symbols/fabric.Point.html">fabric.Point</a></li>
|
|
|
|
<li><a href="../symbols/fabric.Polygon.html">fabric.Polygon</a></li>
|
|
|
|
<li><a href="../symbols/fabric.Polyline.html">fabric.Polyline</a></li>
|
|
|
|
<li><a href="../symbols/fabric.Rect.html">fabric.Rect</a></li>
|
|
|
|
<li><a href="../symbols/fabric.Text.html">fabric.Text</a></li>
|
|
|
|
<li><a href="../symbols/fabric.Triangle.html">fabric.Triangle</a></li>
|
|
|
|
<li><a href="../symbols/fabric.util.html">fabric.util</a></li>
|
|
|
|
<li><a href="../symbols/fabric.util.array.html">fabric.util.array</a></li>
|
|
|
|
<li><a href="../symbols/fabric.util.object.html">fabric.util.object</a></li>
|
|
|
|
<li><a href="../symbols/fabric.util.string.html">fabric.util.string</a></li>
|
|
|
|
<li><a href="../symbols/Function.html">Function</a></li>
|
|
|
|
<li><a href="../symbols/String.html">String</a></li>
|
|
|
|
</ul>
|
|
<hr />
|
|
<!-- end publish.classesIndex -->
|
|
</div>
|
|
|
|
<div id="content">
|
|
<!-- ============================== class title ============================ -->
|
|
<h1 class="classTitle">
|
|
|
|
Class fabric.Color
|
|
</h1>
|
|
|
|
<!-- ============================== class summary ========================== -->
|
|
<p class="description">
|
|
|
|
|
|
|
|
Color
|
|
|
|
|
|
<br /><i>Defined in: </i> <a href="../symbols/src/src_color.class.js.html">color.class.js</a>.
|
|
|
|
</p>
|
|
|
|
<!-- ============================== constructor summary ==================== -->
|
|
|
|
<table class="summaryTable" cellspacing="0" summary="A summary of the constructor documented in the class fabric.Color.">
|
|
<caption>Class Summary</caption>
|
|
<thead>
|
|
<tr>
|
|
<th scope="col">Constructor Attributes</th>
|
|
<th scope="col">Constructor Name and Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class="attributes"> </td>
|
|
<td class="nameDescription" >
|
|
<div class="fixedFont">
|
|
<b><a href="../symbols/fabric.Color.html#constructor">fabric.Color</a></b>(color)
|
|
</div>
|
|
<div class="description">The purpose of <a href="../symbols/fabric.Color.html">fabric.Color</a> is to abstract and encapsulate common color operations;
|
|
<a href="../symbols/fabric.Color.html">fabric.Color</a> is a constructor and creates instances of <a href="../symbols/fabric.Color.html">fabric.Color</a> objects.</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<!-- ============================== properties summary ===================== -->
|
|
|
|
|
|
|
|
<table class="summaryTable" cellspacing="0" summary="A summary of the fields documented in the class fabric.Color.">
|
|
<caption>Field Summary</caption>
|
|
<thead>
|
|
<tr>
|
|
<th scope="col">Field Attributes</th>
|
|
<th scope="col">Field Name and Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
|
|
<tr>
|
|
<td class="attributes"><static> </td>
|
|
<td class="nameDescription">
|
|
<div class="fixedFont">
|
|
fabric.Color.<b><a href="../symbols/fabric.Color.html#.reHex">reHex</a></b>
|
|
</div>
|
|
<div class="description">Regex matching color in HEX format (ex: #FF5555, 010155, aff)</div>
|
|
</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td class="attributes"><static> </td>
|
|
<td class="nameDescription">
|
|
<div class="fixedFont">
|
|
fabric.Color.<b><a href="../symbols/fabric.Color.html#.reRGBa">reRGBa</a></b>
|
|
</div>
|
|
<div class="description">Regex matching color in RGB or RGBA formats (ex: rgb(0, 0, 0), rgb(255, 100, 10, 0.5), rgb(1,1,1))</div>
|
|
</td>
|
|
</tr>
|
|
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ============================== methods summary ======================== -->
|
|
|
|
|
|
|
|
<table class="summaryTable" cellspacing="0" summary="A summary of the methods documented in the class fabric.Color.">
|
|
<caption>Method Summary</caption>
|
|
<thead>
|
|
<tr>
|
|
<th scope="col">Method Attributes</th>
|
|
<th scope="col">Method Name and Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
|
|
<tr>
|
|
<td class="attributes"><static> </td>
|
|
<td class="nameDescription">
|
|
<div class="fixedFont">fabric.Color.<b><a href="../symbols/fabric.Color.html#.fromHex">fromHex</a></b>(color)
|
|
</div>
|
|
<div class="description">Returns new color object, when given a color in HEX format</div>
|
|
</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td class="attributes"><static> </td>
|
|
<td class="nameDescription">
|
|
<div class="fixedFont">fabric.Color.<b><a href="../symbols/fabric.Color.html#.fromRgb">fromRgb</a></b>(color)
|
|
</div>
|
|
<div class="description">Returns new color object, when given a color in RGB format</div>
|
|
</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td class="attributes"><static> </td>
|
|
<td class="nameDescription">
|
|
<div class="fixedFont">fabric.Color.<b><a href="../symbols/fabric.Color.html#.fromRgba">fromRgba</a></b>(color)
|
|
</div>
|
|
<div class="description">Returns new color object, when given a color in RGBA format</div>
|
|
</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td class="attributes"><static> </td>
|
|
<td class="nameDescription">
|
|
<div class="fixedFont">fabric.Color.<b><a href="../symbols/fabric.Color.html#.fromSource">fromSource</a></b>(source)
|
|
</div>
|
|
<div class="description">Returns new color object, when given color in array representation (ex: [200, 100, 100, 0.5])</div>
|
|
</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td class="attributes"> </td>
|
|
<td class="nameDescription">
|
|
<div class="fixedFont"><b><a href="../symbols/fabric.Color.html#getAlpha">getAlpha</a></b>()
|
|
</div>
|
|
<div class="description">Gets value of alpha channel for this color</div>
|
|
</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td class="attributes"> </td>
|
|
<td class="nameDescription">
|
|
<div class="fixedFont"><b><a href="../symbols/fabric.Color.html#getSource">getSource</a></b>()
|
|
</div>
|
|
<div class="description">Returns source of this color (where source is an array representation; ex: [200, 200, 100, 1])</div>
|
|
</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td class="attributes"> </td>
|
|
<td class="nameDescription">
|
|
<div class="fixedFont"><b><a href="../symbols/fabric.Color.html#overlayWith">overlayWith</a></b>(otherColor)
|
|
</div>
|
|
<div class="description">Overlays color with another color</div>
|
|
</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td class="attributes"> </td>
|
|
<td class="nameDescription">
|
|
<div class="fixedFont"><b><a href="../symbols/fabric.Color.html#setAlpha">setAlpha</a></b>(0-1)
|
|
</div>
|
|
<div class="description">Sets value of alpha channel for this color</div>
|
|
</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td class="attributes"> </td>
|
|
<td class="nameDescription">
|
|
<div class="fixedFont"><b><a href="../symbols/fabric.Color.html#setSource">setSource</a></b>(source)
|
|
</div>
|
|
<div class="description">Sets source of this color (where source is an array representation; ex: [200, 200, 100, 1])</div>
|
|
</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td class="attributes"><static> </td>
|
|
<td class="nameDescription">
|
|
<div class="fixedFont">fabric.Color.<b><a href="../symbols/fabric.Color.html#.sourceFromHex">sourceFromHex</a></b>(color)
|
|
</div>
|
|
<div class="description">Returns array represenatation (ex: [100, 100, 200, 1]) of a color that's in HEX format</div>
|
|
</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td class="attributes"><static> </td>
|
|
<td class="nameDescription">
|
|
<div class="fixedFont">fabric.Color.<b><a href="../symbols/fabric.Color.html#.sourceFromRgb">sourceFromRgb</a></b>(color)
|
|
</div>
|
|
<div class="description">Returns array represenatation (ex: [100, 100, 200, 1]) of a color that's in RGB or RGBA format</div>
|
|
</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td class="attributes"> </td>
|
|
<td class="nameDescription">
|
|
<div class="fixedFont"><b><a href="../symbols/fabric.Color.html#toBlackWhite">toBlackWhite</a></b>(threshold)
|
|
</div>
|
|
<div class="description">Transforms color to its black and white representation</div>
|
|
</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td class="attributes"> </td>
|
|
<td class="nameDescription">
|
|
<div class="fixedFont"><b><a href="../symbols/fabric.Color.html#toGrayscale">toGrayscale</a></b>()
|
|
</div>
|
|
<div class="description">Transforms color to its grayscale representation</div>
|
|
</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td class="attributes"> </td>
|
|
<td class="nameDescription">
|
|
<div class="fixedFont"><b><a href="../symbols/fabric.Color.html#toHex">toHex</a></b>()
|
|
</div>
|
|
<div class="description">Returns color represenation in HEX format</div>
|
|
</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td class="attributes"> </td>
|
|
<td class="nameDescription">
|
|
<div class="fixedFont"><b><a href="../symbols/fabric.Color.html#toRgb">toRgb</a></b>()
|
|
</div>
|
|
<div class="description">Returns color represenation in RGB format</div>
|
|
</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td class="attributes"> </td>
|
|
<td class="nameDescription">
|
|
<div class="fixedFont"><b><a href="../symbols/fabric.Color.html#toRgba">toRgba</a></b>()
|
|
</div>
|
|
<div class="description">Returns color represenation in RGBA format</div>
|
|
</td>
|
|
</tr>
|
|
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
|
|
|
|
<!-- ============================== events summary ======================== -->
|
|
|
|
|
|
<!-- ============================== constructor details ==================== -->
|
|
|
|
<div class="details"><a name="constructor"> </a>
|
|
<div class="sectionTitle">
|
|
Class Detail
|
|
</div>
|
|
|
|
<div class="fixedFont">
|
|
<b>fabric.Color</b>(color)
|
|
</div>
|
|
|
|
<div class="description">
|
|
The purpose of <a href="../symbols/fabric.Color.html">fabric.Color</a> is to abstract and encapsulate common color operations;
|
|
<a href="../symbols/fabric.Color.html">fabric.Color</a> is a constructor and creates instances of <a href="../symbols/fabric.Color.html">fabric.Color</a> objects.
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="detailList">
|
|
<dt class="heading">Parameters:</dt>
|
|
|
|
<dt>
|
|
<span class="light fixedFont">{<a href="../symbols/String.html">String</a>}</span> <b>color</b>
|
|
|
|
</dt>
|
|
<dd>(optional) in hex or rgb(a) format</dd>
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<!-- ============================== field details ========================== -->
|
|
|
|
<div class="sectionTitle">
|
|
Field Detail
|
|
</div>
|
|
|
|
<a name=".reHex"> </a>
|
|
<div class="fixedFont"><static>
|
|
|
|
|
|
<span class="light">fabric.Color.</span><b>reHex</b>
|
|
|
|
</div>
|
|
<div class="description">
|
|
Regex matching color in HEX format (ex: #FF5555, 010155, aff)
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
|
|
<a name=".reRGBa"> </a>
|
|
<div class="fixedFont"><static>
|
|
|
|
|
|
<span class="light">fabric.Color.</span><b>reRGBa</b>
|
|
|
|
</div>
|
|
<div class="description">
|
|
Regex matching color in RGB or RGBA formats (ex: rgb(0, 0, 0), rgb(255, 100, 10, 0.5), rgb(1,1,1))
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ============================== method details ========================= -->
|
|
|
|
<div class="sectionTitle">
|
|
Method Detail
|
|
</div>
|
|
|
|
<a name=".fromHex"> </a>
|
|
<div class="fixedFont"><static>
|
|
|
|
<span class="light">{<a href="../symbols/fabric.Color.html">fabric.Color</a>}</span>
|
|
<span class="light">fabric.Color.</span><b>fromHex</b>(color)
|
|
|
|
</div>
|
|
<div class="description">
|
|
Returns new color object, when given a color in HEX format
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<dl class="detailList">
|
|
<dt class="heading">Parameters:</dt>
|
|
|
|
<dt>
|
|
<b>color</b>
|
|
|
|
</dt>
|
|
<dd></dd>
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="detailList">
|
|
<dt class="heading">Returns:</dt>
|
|
|
|
<dd><span class="light fixedFont">{<a href="../symbols/fabric.Color.html">fabric.Color</a>}</span> </dd>
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
|
|
<a name=".fromRgb"> </a>
|
|
<div class="fixedFont"><static>
|
|
|
|
<span class="light">{<a href="../symbols/fabric.Color.html">fabric.Color</a>}</span>
|
|
<span class="light">fabric.Color.</span><b>fromRgb</b>(color)
|
|
|
|
</div>
|
|
<div class="description">
|
|
Returns new color object, when given a color in RGB format
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<dl class="detailList">
|
|
<dt class="heading">Parameters:</dt>
|
|
|
|
<dt>
|
|
<span class="light fixedFont">{<a href="../symbols/String.html">String</a>}</span> <b>color</b>
|
|
|
|
</dt>
|
|
<dd>ex: rgb(0-255,0-255,0-255)</dd>
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="detailList">
|
|
<dt class="heading">Returns:</dt>
|
|
|
|
<dd><span class="light fixedFont">{<a href="../symbols/fabric.Color.html">fabric.Color</a>}</span> </dd>
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
|
|
<a name=".fromRgba"> </a>
|
|
<div class="fixedFont"><static>
|
|
|
|
<span class="light">{<a href="../symbols/fabric.Color.html">fabric.Color</a>}</span>
|
|
<span class="light">fabric.Color.</span><b>fromRgba</b>(color)
|
|
|
|
</div>
|
|
<div class="description">
|
|
Returns new color object, when given a color in RGBA format
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<dl class="detailList">
|
|
<dt class="heading">Parameters:</dt>
|
|
|
|
<dt>
|
|
<span class="light fixedFont">{<a href="../symbols/String.html">String</a>}</span> <b>color</b>
|
|
|
|
</dt>
|
|
<dd></dd>
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="detailList">
|
|
<dt class="heading">Returns:</dt>
|
|
|
|
<dd><span class="light fixedFont">{<a href="../symbols/fabric.Color.html">fabric.Color</a>}</span> </dd>
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
|
|
<a name=".fromSource"> </a>
|
|
<div class="fixedFont"><static>
|
|
|
|
<span class="light">{<a href="../symbols/fabric.Color.html">fabric.Color</a>}</span>
|
|
<span class="light">fabric.Color.</span><b>fromSource</b>(source)
|
|
|
|
</div>
|
|
<div class="description">
|
|
Returns new color object, when given color in array representation (ex: [200, 100, 100, 0.5])
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<dl class="detailList">
|
|
<dt class="heading">Parameters:</dt>
|
|
|
|
<dt>
|
|
<b>source</b>
|
|
|
|
</dt>
|
|
<dd></dd>
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="detailList">
|
|
<dt class="heading">Returns:</dt>
|
|
|
|
<dd><span class="light fixedFont">{<a href="../symbols/fabric.Color.html">fabric.Color</a>}</span> </dd>
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
|
|
<a name="getAlpha"> </a>
|
|
<div class="fixedFont">
|
|
|
|
<span class="light">{Number}</span>
|
|
<b>getAlpha</b>()
|
|
|
|
</div>
|
|
<div class="description">
|
|
Gets value of alpha channel for this color
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="detailList">
|
|
<dt class="heading">Returns:</dt>
|
|
|
|
<dd><span class="light fixedFont">{Number}</span> 0-1</dd>
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
|
|
<a name="getSource"> </a>
|
|
<div class="fixedFont">
|
|
|
|
<span class="light">{<a href="../symbols/Array.html">Array</a>}</span>
|
|
<b>getSource</b>()
|
|
|
|
</div>
|
|
<div class="description">
|
|
Returns source of this color (where source is an array representation; ex: [200, 200, 100, 1])
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="detailList">
|
|
<dt class="heading">Returns:</dt>
|
|
|
|
<dd><span class="light fixedFont">{<a href="../symbols/Array.html">Array</a>}</span> </dd>
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
|
|
<a name="overlayWith"> </a>
|
|
<div class="fixedFont">
|
|
|
|
<span class="light">{<a href="../symbols/fabric.Color.html">fabric.Color</a>}</span>
|
|
<b>overlayWith</b>(otherColor)
|
|
|
|
</div>
|
|
<div class="description">
|
|
Overlays color with another color
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<dl class="detailList">
|
|
<dt class="heading">Parameters:</dt>
|
|
|
|
<dt>
|
|
<span class="light fixedFont">{<a href="../symbols/String.html">String</a>|<a href="../symbols/fabric.Color.html">fabric.Color</a>}</span> <b>otherColor</b>
|
|
|
|
</dt>
|
|
<dd></dd>
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="detailList">
|
|
<dt class="heading">Returns:</dt>
|
|
|
|
<dd><span class="light fixedFont">{<a href="../symbols/fabric.Color.html">fabric.Color</a>}</span> thisArg</dd>
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
|
|
<a name="setAlpha"> </a>
|
|
<div class="fixedFont">
|
|
|
|
<span class="light">{<a href="../symbols/fabric.Color.html">fabric.Color</a>}</span>
|
|
<b>setAlpha</b>(0-1)
|
|
|
|
</div>
|
|
<div class="description">
|
|
Sets value of alpha channel for this color
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<dl class="detailList">
|
|
<dt class="heading">Parameters:</dt>
|
|
|
|
<dt>
|
|
<span class="light fixedFont">{Number}</span> <b>0-1</b>
|
|
|
|
</dt>
|
|
<dd></dd>
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="detailList">
|
|
<dt class="heading">Returns:</dt>
|
|
|
|
<dd><span class="light fixedFont">{<a href="../symbols/fabric.Color.html">fabric.Color</a>}</span> thisArg</dd>
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
|
|
<a name="setSource"> </a>
|
|
<div class="fixedFont">
|
|
|
|
|
|
<b>setSource</b>(source)
|
|
|
|
</div>
|
|
<div class="description">
|
|
Sets source of this color (where source is an array representation; ex: [200, 200, 100, 1])
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<dl class="detailList">
|
|
<dt class="heading">Parameters:</dt>
|
|
|
|
<dt>
|
|
<span class="light fixedFont">{<a href="../symbols/Array.html">Array</a>}</span> <b>source</b>
|
|
|
|
</dt>
|
|
<dd></dd>
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
|
|
<a name=".sourceFromHex"> </a>
|
|
<div class="fixedFont"><static>
|
|
|
|
<span class="light">{<a href="../symbols/Array.html">Array</a>}</span>
|
|
<span class="light">fabric.Color.</span><b>sourceFromHex</b>(color)
|
|
|
|
</div>
|
|
<div class="description">
|
|
Returns array represenatation (ex: [100, 100, 200, 1]) of a color that's in HEX format
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<dl class="detailList">
|
|
<dt class="heading">Parameters:</dt>
|
|
|
|
<dt>
|
|
<span class="light fixedFont">{<a href="../symbols/String.html">String</a>}</span> <b>color</b>
|
|
|
|
</dt>
|
|
<dd>ex: FF5555</dd>
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="detailList">
|
|
<dt class="heading">Returns:</dt>
|
|
|
|
<dd><span class="light fixedFont">{<a href="../symbols/Array.html">Array</a>}</span> source</dd>
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
|
|
<a name=".sourceFromRgb"> </a>
|
|
<div class="fixedFont"><static>
|
|
|
|
<span class="light">{<a href="../symbols/Array.html">Array</a>}</span>
|
|
<span class="light">fabric.Color.</span><b>sourceFromRgb</b>(color)
|
|
|
|
</div>
|
|
<div class="description">
|
|
Returns array represenatation (ex: [100, 100, 200, 1]) of a color that's in RGB or RGBA format
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<dl class="detailList">
|
|
<dt class="heading">Parameters:</dt>
|
|
|
|
<dt>
|
|
<span class="light fixedFont">{<a href="../symbols/String.html">String</a>}</span> <b>color</b>
|
|
|
|
</dt>
|
|
<dd>ex: rgb(0-255,0-255,0-255)</dd>
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="detailList">
|
|
<dt class="heading">Returns:</dt>
|
|
|
|
<dd><span class="light fixedFont">{<a href="../symbols/Array.html">Array</a>}</span> source</dd>
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
|
|
<a name="toBlackWhite"> </a>
|
|
<div class="fixedFont">
|
|
|
|
<span class="light">{<a href="../symbols/fabric.Color.html">fabric.Color</a>}</span>
|
|
<b>toBlackWhite</b>(threshold)
|
|
|
|
</div>
|
|
<div class="description">
|
|
Transforms color to its black and white representation
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<dl class="detailList">
|
|
<dt class="heading">Parameters:</dt>
|
|
|
|
<dt>
|
|
<b>threshold</b>
|
|
|
|
</dt>
|
|
<dd></dd>
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="detailList">
|
|
<dt class="heading">Returns:</dt>
|
|
|
|
<dd><span class="light fixedFont">{<a href="../symbols/fabric.Color.html">fabric.Color</a>}</span> thisArg</dd>
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
|
|
<a name="toGrayscale"> </a>
|
|
<div class="fixedFont">
|
|
|
|
<span class="light">{<a href="../symbols/fabric.Color.html">fabric.Color</a>}</span>
|
|
<b>toGrayscale</b>()
|
|
|
|
</div>
|
|
<div class="description">
|
|
Transforms color to its grayscale representation
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="detailList">
|
|
<dt class="heading">Returns:</dt>
|
|
|
|
<dd><span class="light fixedFont">{<a href="../symbols/fabric.Color.html">fabric.Color</a>}</span> thisArg</dd>
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
|
|
<a name="toHex"> </a>
|
|
<div class="fixedFont">
|
|
|
|
<span class="light">{<a href="../symbols/String.html">String</a>}</span>
|
|
<b>toHex</b>()
|
|
|
|
</div>
|
|
<div class="description">
|
|
Returns color represenation in HEX format
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="detailList">
|
|
<dt class="heading">Returns:</dt>
|
|
|
|
<dd><span class="light fixedFont">{<a href="../symbols/String.html">String</a>}</span> ex: FF5555</dd>
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
|
|
<a name="toRgb"> </a>
|
|
<div class="fixedFont">
|
|
|
|
<span class="light">{<a href="../symbols/String.html">String</a>}</span>
|
|
<b>toRgb</b>()
|
|
|
|
</div>
|
|
<div class="description">
|
|
Returns color represenation in RGB format
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="detailList">
|
|
<dt class="heading">Returns:</dt>
|
|
|
|
<dd><span class="light fixedFont">{<a href="../symbols/String.html">String</a>}</span> ex: rgb(0-255,0-255,0-255)</dd>
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
|
|
<a name="toRgba"> </a>
|
|
<div class="fixedFont">
|
|
|
|
<span class="light">{<a href="../symbols/String.html">String</a>}</span>
|
|
<b>toRgba</b>()
|
|
|
|
</div>
|
|
<div class="description">
|
|
Returns color represenation in RGBA format
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="detailList">
|
|
<dt class="heading">Returns:</dt>
|
|
|
|
<dd><span class="light fixedFont">{<a href="../symbols/String.html">String</a>}</span> ex: rgba(0-255,0-255,0-255,0-1)</dd>
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ============================== event details ========================= -->
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
|
|
|
|
<!-- ============================== footer ================================= -->
|
|
<div class="fineprint" style="clear:both">
|
|
|
|
Documentation generated by <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blank">JsDoc Toolkit</a> 2.4.0 on Tue Jun 28 2011 18:47:43 GMT-0400 (EDT)
|
|
</div>
|
|
</body>
|
|
</html>
|