Skip to content

Commit 5ef408a

Browse files
mscoutermarshmscoutermarsh
committed
update docs
1 parent 972f742 commit 5ef408a

File tree

7 files changed

+372
-25
lines changed

7 files changed

+372
-25
lines changed

‎docs/HTMLCSSToImage.html‎

Lines changed: 286 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -133,7 +133,7 @@ <h2>
133133
<dt id="VERSION-constant" class="">VERSION =
134134

135135
</dt>
136-
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>0.1.0</span><span class='tstring_end'>&quot;</span></span></pre></dd>
136+
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>0.1.1</span><span class='tstring_end'>&quot;</span></span></pre></dd>
137137

138138
</dl>
139139

@@ -197,6 +197,30 @@ <h2>
197197
<p>Creates a signed URL for generating an image from a template This URL contains the template_values in it.</p>
198198
</div></span>
199199

200+
</li>
201+
202+
203+
<li class="public ">
204+
<span class="summary_signature">
205+
206+
<a href="#create_template-instance_method" title="#create_template (instance method)">#<strong>create_template</strong>(html, params = {}) &#x21d2; HTMLCSSToImage::ApiResponse </a>
207+
208+
209+
210+
</span>
211+
212+
213+
214+
215+
216+
217+
218+
219+
220+
<span class="summary_desc"><div class='inline'>
221+
<p>Creates an image template.</p>
222+
</div></span>
223+
200224
</li>
201225

202226

@@ -702,6 +726,7 @@ <h3 class="signature " id="create_image_from_template-instance_method">
702726
<pre class="lines">
703727

704728

729+
86
705730
87
706731
88
707732
89
@@ -716,11 +741,10 @@ <h3 class="signature " id="create_image_from_template-instance_method">
716741
98
717742
99
718743
100
719-
101
720-
102</pre>
744+
101</pre>
721745
</td>
722746
<td>
723-
<pre class="code"><span class="info file"># File 'lib/htmlcsstoimage.rb', line 87</span>
747+
<pre class="code"><span class="info file"># File 'lib/htmlcsstoimage.rb', line 86</span>
724748

725749
<span class='kw'>def</span> <span class='id identifier rubyid_create_image_from_template'>create_image_from_template</span><span class='lparen'>(</span><span class='id identifier rubyid_template_id'>template_id</span><span class='comma'>,</span> <span class='id identifier rubyid_template_values'>template_values</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
726750
<span class='id identifier rubyid_template'>template</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="#SIGNED_URL_TEMPLATE-constant" title="HTMLCSSToImage::SIGNED_URL_TEMPLATE (constant)">SIGNED_URL_TEMPLATE</a></span></span><span class='period'>.</span><span class='id identifier rubyid_partial_expand'>partial_expand</span><span class='lparen'>(</span><span class='lbrace'>{</span>
@@ -741,6 +765,257 @@ <h3 class="signature " id="create_image_from_template-instance_method">
741765
</td>
742766
</tr>
743767
</table>
768+
</div>
769+
770+
<div class="method_details ">
771+
<h3 class="signature " id="create_template-instance_method">
772+
773+
#<strong>create_template</strong>(html, params = {}) &#x21d2; <tt><span class='object_link'><a href="HTMLCSSToImage/ApiResponse.html" title="HTMLCSSToImage::ApiResponse (class)">HTMLCSSToImage::ApiResponse</a></span></tt>
774+
775+
776+
777+
778+
779+
</h3><div class="docstring">
780+
<div class="discussion">
781+
782+
<p>Creates an image template</p>
783+
784+
785+
</div>
786+
</div>
787+
<div class="tags">
788+
<p class="tag_title">Parameters:</p>
789+
<ul class="param">
790+
791+
<li>
792+
793+
<span class='name'>html</span>
794+
795+
796+
<span class='type'>(<tt>String</tt>)</span>
797+
798+
799+
800+
&mdash;
801+
<div class='inline'>
802+
<p>This is the HTML you want to render. You can send an HTML snippet (`&lt;div&gt;Your content&lt;/div&gt;`) or an entire webpage.</p>
803+
</div>
804+
805+
</li>
806+
807+
<li>
808+
809+
<span class='name'>params</span>
810+
811+
812+
<span class='type'>(<tt>Hash</tt>)</span>
813+
814+
815+
<em class="default">(defaults to: <tt>{}</tt>)</em>
816+
817+
818+
&mdash;
819+
<div class='inline'>
820+
<p>a customizable set of options</p>
821+
</div>
822+
823+
</li>
824+
825+
</ul>
826+
827+
828+
829+
830+
831+
832+
<p class="tag_title">Options Hash (<tt>params</tt>):</p>
833+
<ul class="option">
834+
835+
<li>
836+
<span class="name">:name</span>
837+
<span class="type">(<tt>String</tt>)</span>
838+
<span class="default">
839+
840+
</span>
841+
842+
&mdash; <div class='inline'>
843+
<p>A short name to identify your template max length 64</p>
844+
</div>
845+
846+
</li>
847+
848+
<li>
849+
<span class="name">:description</span>
850+
<span class="type">(<tt>String</tt>)</span>
851+
<span class="default">
852+
853+
</span>
854+
855+
&mdash; <div class='inline'>
856+
<p>Description to elaborate on the use of your template max length 1024</p>
857+
</div>
858+
859+
</li>
860+
861+
<li>
862+
<span class="name">:css</span>
863+
<span class="type">(<tt>String</tt>)</span>
864+
<span class="default">
865+
866+
</span>
867+
868+
&mdash; <div class='inline'>
869+
<p>The CSS for your image.</p>
870+
</div>
871+
872+
</li>
873+
874+
<li>
875+
<span class="name">:google_fonts</span>
876+
<span class="type">(<tt>String</tt>)</span>
877+
<span class="default">
878+
879+
</span>
880+
881+
&mdash; <div class='inline'>
882+
<p>[Google fonts](<a href="https://docs.htmlcsstoimage.com/guides/using-google-fonts">docs.htmlcsstoimage.com/guides/using-google-fonts</a>/) to be loaded. Example: `Roboto`. Multiple fonts can be loaded like this: `Roboto|Open Sans`</p>
883+
</div>
884+
885+
</li>
886+
887+
<li>
888+
<span class="name">:selector</span>
889+
<span class="type">(<tt>String</tt>)</span>
890+
<span class="default">
891+
892+
</span>
893+
894+
&mdash; <div class='inline'>
895+
<p>A CSS selector for an element on the webpage. We&#39;ll crop the image to this specific element. For example: `section#complete-toolkit.container-lg`</p>
896+
</div>
897+
898+
</li>
899+
900+
<li>
901+
<span class="name">:ms_delay</span>
902+
<span class="type">(<tt>Integer</tt>)</span>
903+
<span class="default">
904+
905+
</span>
906+
907+
&mdash; <div class='inline'>
908+
<p>The number of milliseconds the API should delay before generating the image. This is useful when waiting for JavaScript. We recommend starting with `500`. Large values slow down the initial render time.</p>
909+
</div>
910+
911+
</li>
912+
913+
<li>
914+
<span class="name">:device_scale</span>
915+
<span class="type">(<tt>Double</tt>)</span>
916+
<span class="default">
917+
918+
</span>
919+
920+
&mdash; <div class='inline'>
921+
<p>This adjusts the pixel ratio for the screenshot. Minimum: `1`, Maximum: `3`.</p>
922+
</div>
923+
924+
</li>
925+
926+
<li>
927+
<span class="name">:render_when_ready</span>
928+
<span class="type">(<tt>Boolean</tt>)</span>
929+
<span class="default">
930+
931+
</span>
932+
933+
&mdash; <div class='inline'>
934+
<p>Set to true to control when the image is generated. Call `ScreenshotReady()` from JavaScript to generate the image. [Learn more](<a href="https://docs.htmlcsstoimage.com/guides/render-when-ready">docs.htmlcsstoimage.com/guides/render-when-ready</a>/).</p>
935+
</div>
936+
937+
</li>
938+
939+
<li>
940+
<span class="name">:viewport_width</span>
941+
<span class="type">(<tt>Integer</tt>)</span>
942+
<span class="default">
943+
944+
</span>
945+
946+
&mdash; <div class='inline'>
947+
<p>Set the width of Chrome&#39;s viewport. This will disable automatic cropping. Both height and width parameters must be set if using either.</p>
948+
</div>
949+
950+
</li>
951+
952+
<li>
953+
<span class="name">:viewport_height</span>
954+
<span class="type">(<tt>Integer</tt>)</span>
955+
<span class="default">
956+
957+
</span>
958+
959+
&mdash; <div class='inline'>
960+
<p>Set the height of Chrome&#39;s viewport. This will disable automatic cropping. Both height and width parameters must be set if using either.</p>
961+
</div>
962+
963+
</li>
964+
965+
</ul>
966+
967+
968+
<p class="tag_title">Returns:</p>
969+
<ul class="return">
970+
971+
<li>
972+
973+
974+
<span class='type'>(<tt><span class='object_link'><a href="HTMLCSSToImage/ApiResponse.html" title="HTMLCSSToImage::ApiResponse (class)">HTMLCSSToImage::ApiResponse</a></span></tt>)</span>
975+
976+
977+
978+
&mdash;
979+
<div class='inline'>
980+
<p>image URL available at `.url`.</p>
981+
</div>
982+
983+
</li>
984+
985+
</ul>
986+
987+
<p class="tag_title">See Also:</p>
988+
<ul class="see">
989+
990+
<li><a href="https://docs.htmlcsstoimage.com/getting-started/templates/" target="_parent" title="https://docs.htmlcsstoimage.com/getting-started/templates/">https://docs.htmlcsstoimage.com/getting-started/templates/</a></li>
991+
992+
</ul>
993+
994+
</div><table class="source_code">
995+
<tr>
996+
<td>
997+
<pre class="lines">
998+
999+
1000+
147
1001+
148
1002+
149
1003+
150
1004+
151
1005+
152</pre>
1006+
</td>
1007+
<td>
1008+
<pre class="code"><span class="info file"># File 'lib/htmlcsstoimage.rb', line 147</span>
1009+
1010+
<span class='kw'>def</span> <span class='id identifier rubyid_create_template'>create_template</span><span class='lparen'>(</span><span class='id identifier rubyid_html'>html</span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
1011+
<span class='id identifier rubyid_body'>body</span> <span class='op'>=</span> <span class='lbrace'>{</span> <span class='label'>html:</span> <span class='id identifier rubyid_html'>html</span> <span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span><span class='id identifier rubyid_params'>params</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to_json'>to_json</span>
1012+
<span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span> <span class='label'>basic_auth:</span> <span class='ivar'>@auth</span><span class='comma'>,</span> <span class='label'>body:</span> <span class='id identifier rubyid_body'>body</span> <span class='rbrace'>}</span>
1013+
1014+
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='period'>.</span><span class='id identifier rubyid_post'>post</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/v1/template</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
1015+
<span class='kw'>end</span></pre>
1016+
</td>
1017+
</tr>
1018+
</table>
7441019
</div>
7451020

7461021
<div class="method_details ">
@@ -852,13 +1127,13 @@ <h3 class="signature " id="templates-instance_method">
8521127
<pre class="lines">
8531128

8541129

1130+
124
8551131
125
8561132
126
857-
127
858-
128</pre>
1133+
127</pre>
8591134
</td>
8601135
<td>
861-
<pre class="code"><span class="info file"># File 'lib/htmlcsstoimage.rb', line 125</span>
1136+
<pre class="code"><span class="info file"># File 'lib/htmlcsstoimage.rb', line 124</span>
8621137

8631138
<span class='kw'>def</span> <span class='id identifier rubyid_templates'>templates</span><span class='lparen'>(</span><span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
8641139
<span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='id identifier rubyid_params'>params</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span><span class='lbrace'>{</span> <span class='label'>basic_auth:</span> <span class='ivar'>@auth</span> <span class='rbrace'>}</span><span class='rparen'>)</span>
@@ -1029,15 +1304,15 @@ <h3 class="signature " id="url_to_image-instance_method">
10291304
<pre class="lines">
10301305

10311306

1307+
114
10321308
115
10331309
116
10341310
117
10351311
118
1036-
119
1037-
120</pre>
1312+
119</pre>
10381313
</td>
10391314
<td>
1040-
<pre class="code"><span class="info file"># File 'lib/htmlcsstoimage.rb', line 115</span>
1315+
<pre class="code"><span class="info file"># File 'lib/htmlcsstoimage.rb', line 114</span>
10411316

10421317
<span class='kw'>def</span> <span class='id identifier rubyid_url_to_image'>url_to_image</span><span class='lparen'>(</span><span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
10431318
<span class='id identifier rubyid_body'>body</span> <span class='op'>=</span> <span class='lbrace'>{</span> <span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span> <span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span><span class='id identifier rubyid_params'>params</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to_json'>to_json</span>
@@ -1055,7 +1330,7 @@ <h3 class="signature " id="url_to_image-instance_method">
10551330
</div>
10561331

10571332
<div id="footer">
1058-
Generated on Fri Aug 7 11:01:21 2020 by
1333+
Generated on Fri Aug 7 13:04:07 2020 by
10591334
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
10601335
0.9.25 (ruby-2.6.5).
10611336
</div>

‎docs/HTMLCSSToImage/ApiResponse.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,7 @@
114114
</div>
115115

116116
<div id="footer">
117-
Generated on Fri Aug 7 11:01:21 2020 by
117+
Generated on Fri Aug 7 13:04:07 2020 by
118118
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
119119
0.9.25 (ruby-2.6.5).
120120
</div>

‎docs/_index.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,7 @@ <h2>Namespace Listing A-Z</h2>
112112
</div>
113113

114114
<div id="footer">
115-
Generated on Fri Aug 7 11:01:21 2020 by
115+
Generated on Fri Aug 7 13:04:07 2020 by
116116
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
117117
0.9.25 (ruby-2.6.5).
118118
</div>

0 commit comments

Comments
 (0)