Cantabile JavaScript API Cantabile JavaScript API

  • API Docs for Version: 4.0.0

    • Show:

    ShowNote.js File

    1. /**
    2.  * An anonymous type representing a show note
    3.  *
    4.  * @class ShowNote
    5.  */
    6.  
    7. /** 
    8.  * The item kind - either "song" or "break"
    9.  * @property kind
    10.  * @type {String}
    11.  */
    12.  
    13. /** 
    14.  * The name of the song or break
    15.  * @property name
    16.  * @type {String}
    17.  */
    18.  
    19. /** 
    20.  * The zero based program number of a song
    21.  * @property pr
    22.  * @type {Number}
    23.  */
    24.  
    25. /** 
    26.  * The color of the item (0 to 15)
    27.  * @property color
    28.  * @type {Number}
    29.  */
    30.  
    31.  
    32. /**
    33.  * Background color (0 - 15)
    34.  * @property backgroundColor
    35.  * @type {Number}  
    36.  */
    37.  
    38. /**
    39.  * Bold font
    40.  * @property bold
    41.  * @type {Boolean} 
    42.  */
    43.  
    44. /**
    45.  * Fixed pitch font
    46.  * @property fixedPitch
    47.  * @type {Boolean}
    48.  */
    49.  
    50. /**
    51.  * Font size
    52.  * @property fontSize
    53.  * @type {Number}  
    54.  */
    55.  
    56. /**
    57.  * True if the show note is currently hidden
    58.  * @property hidden
    59.  * @type {Boolean} 
    60.  */
    61.  
    62. /**
    63.  * URL to retrieve the note's background image (or null)
    64.  * @property imageUrl
    65.  * @type {String}  
    66.  */
    67.  
    68. /**
    69.  * How much to scale the image by (0.0 - 1.0)
    70.  * @property imageScale
    71.  * @type {Number}  
    72.  */
    73.  
    74. /**
    75.  * Width of the image in pixels
    76.  * @property imageWidth
    77.  * @type {Number}  
    78.  */
    79.  
    80. /**
    81.  * Height of the image in pixels
    82.  * @property imageHeight
    83.  * @type {Number}  
    84.  */
    85.  
    86. /**
    87.  * The show note's text
    88.  * @property text
    89.  * @type {String}  
    90.  */
    91.  
    92. /**
    93.  * Text alignment ("left", "center" or "right")
    94.  * @property textAlign
    95.  * @type {String} 
    96.  */
    97.  
    98. /**
    99.  * Text color (0 - 15)
    100.  * @property textColor
    101.  * @type {Number}  
    102.  */
    103.  
    104.