User Tools

Site Tools


en:template:styles

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
Last revision Both sides next revision
en:template:styles [2016/08/10 16:53]
Nicolas Ronvel [Canvas fields and Inheritance]
en:template:styles [2017/01/24 14:30]
Nicolas Ronvel [Editable Fields]
Line 58: Line 58:
   * ''​default''​ : default value that will fill the field when a new card is created   * ''​default''​ : default value that will fill the field when a new card is created
   * ''​isNameField''​ : is this field the one that describe the card ? If ''​true'',​ the value of this field will be used to identify the card in the list. See the [[..:​manual:​list-of-cards|List of cards]].   * ''​isNameField''​ : is this field the one that describe the card ? If ''​true'',​ the value of this field will be used to identify the card in the list. See the [[..:​manual:​list-of-cards|List of cards]].
 +  * ''​group''​ (optional) : specifies the name of the [[Group of Fields|Group]] the field is part of. The Group must exist, and a Group cannot be in a Group.
  
 Each type of fields then have different properties that define how it is displayed, what data can be obtained with it, and so on. Here's the list of available editable fields : Each type of fields then have different properties that define how it is displayed, what data can be obtained with it, and so on. Here's the list of available editable fields :
  
 +  * [[Group of Fields]]
   * [[Text input]]   * [[Text input]]
   * [[Choice input]]   * [[Choice input]]
Line 69: Line 71:
   * [[Numeric Input Field]]   * [[Numeric Input Field]]
   * [[Color Picker]]   * [[Color Picker]]
 +
 +=== Order of the Editable fields ===
 +
 +The editable fields are //​displayed//​ one after the other, the first item of the array being the one first displayed. You can change this by setting an ''​order''​ property on a field, and defining the order of the element (an integer). The editable fields are sorted in ascending order. ​
 +
 +Note that the ''​order''​ property is set by default to a value of ''​1''​.
  
 ==== The Card / Canvas ==== ==== The Card / Canvas ====
Line 82: Line 90:
   * [[Code Variables]]   * [[Code Variables]]
  
 +=== Order of the Canvas elements ===
 +
 +The elements of the canvas are //drawn// one after the other, the first item of the array being the one first drawn. You can change this by setting an ''​order''​ property on a field, and defining the order of the element (an integer). The elements of the canvas are sorted in ascending order. ​
 +
 +Note that the ''​order''​ property is set by default to a value of ''​1''​.
 ===== Inheriting styles ===== ===== Inheriting styles =====
  
Line 155: Line 168:
  
 <code javascript>​ <code javascript>​
-    ​"​fields":​ [ +"​fields":​ [ 
-        { "​name":​ "​field01",​ "​label":​ "Name :", "​default":​ "​Default name", "​isNameField":​ true }, +    { "​name":​ "​field01",​ "​label":​ "Name :", "​default":​ "​Default name", "​isNameField":​ true }, 
-        { "​name":​ "​field02",​ "​label":​ "Class :", "​default":​ "​Default class",​ "​isNameField":​ false } +    { "​name":​ "​field02",​ "​label":​ "Class :", "​default":​ "​Default class",​ "​isNameField":​ false } 
-    ]+]
 </​code>​ </​code>​
  
Line 164: Line 177:
  
 <code javascript>​ <code javascript>​
-    ​"​fields":​ [ +"​fields":​ [ 
-        { "​name":​ "​field02",​ "​label":​ "​Current Class :" } +    { "​name":​ "​field02",​ "​label":​ "​Current Class :" } 
-        { "​name":​ "​field03",​ "​label":​ "Level :", "​default":​ "​Default level" } +    { "​name":​ "​field03",​ "​label":​ "Level :", "​default":​ "​Default level" } 
-    ]+]
 </​code>​ </​code>​
  
Line 205: Line 218:
  
 Any property of a canvasField can be modified in a child canvasField : ''​text'',​ ''​left'',​ ''​top'',​ ''​fontFamily'',​ ... Feel free to have a look at existing templates to discover how inheritance works. Any property of a canvasField can be modified in a child canvasField : ''​text'',​ ''​left'',​ ''​top'',​ ''​fontFamily'',​ ... Feel free to have a look at existing templates to discover how inheritance works.
 +
 +==== Ignoring a Parent field ====
 +
 +Following the completion of [[http://​www.github.com/​gulix/​geckos/​issues/​102|Issue #102]], you can use the property ''​ignored''​ in a field (//​editable//​ or //canvas// field) and set it to ''​true''​ in order to ignore it in the generated style (it will not be inserted in the arrays).
 +
 +This property follows all the rules of inheritance. If a parent style set it to ''​true'',​ a child could still reset it to ''​false''​.
 +
en/template/styles.txt · Last modified: 2017/07/18 16:10 by Nicolas Ronvel