Optional Embed Arguments - Revision history

MCB: /* Argument: AltTitle (String) */

2018-09-10T15:37:22Z

‎Argument: AltTitle (String)

MCB: /* Argument: GLName (String) */

2018-09-10T15:37:13Z

‎Argument: GLName (String)

MCB at 20:07, 24 August 2018

2018-08-24T20:07:22Z

MCB at 20:00, 24 August 2018

2018-08-24T20:00:32Z

SNC at 22:30, 29 November 2016

2016-11-29T22:30:32Z

RB at 17:44, 9 September 2016

2016-09-09T17:44:32Z

RB: /* Argument: GLName (String)' */

2016-09-09T17:43:04Z

‎Argument: GLName (String)'

RB at 17:42, 9 September 2016

2016-09-09T17:42:45Z

RB at 17:42, 9 September 2016

2016-09-09T17:42:19Z

RB at 17:39, 9 September 2016

2016-09-09T17:39:03Z

@@ Line 25: / Line 25: @@
 Purpose: A string to be used as an alternate title, replacing the one the embed was built with.
-Supported By: Tables, LatestValues, Charts
+Supported By: Tables, LatestValues, Charts, Widgets
 Details & Notes:
 The text may optionally include HTML/CSS markup to help stylize the new title.
 ===Argument: AltExtSrc (String)===

@@ Line 11: / Line 11: @@
 Purpose: This lets a display be re-used as a template by replacing its contents dynamically. You could, for example, build a table showing several series for a particular county, and re-use the table by providing a GroupList with corresponding data for a different county.
-Supported By: Tables, LatestValues, Charts
+Supported By: Tables, LatestValues, Charts, Widgets
 Details & Notes:
@@ Line 18: / Line 18: @@
 If a provided GroupList name doesn't exist or is invalid (typo) then the default data (that which the embed was built with) is displayed.
 In the case of LatestValues displays, multiple GroupLists can be passed (delimited by "##SPLIT##") to generate a cross-sectional display.
 ===Argument: AltTitle (String)===

@@ Line 18: / Line 18: @@
 If a provided GroupList name doesn't exist or is invalid (typo) then the default data (that which the embed was built with) is displayed.
 In the case of LatestValues displays, multiple GroupLists can be passed (delimited by "##SPLIT##") to generate a cross-sectional display.
 ===Argument: AltTitle (String)===
@@ Line 30: / Line 31: @@
 The text may optionally include HTML/CSS markup to help stylize the new title.
 ===Argument: AltExtSrc (String)===
@@ Line 48: / Line 50: @@
 Extra GroupLists names (beyond the last External Data column, position wise) will be ignored (but will still factor into a cached variant of the embed).
 Future expansion may allow for providing names of alternate external sources which aren't specifically GroupList names.
 ===Argument: XSectDate (Date)===
@@ Line 69: / Line 72: @@
 If the keyword "LATEST" is provided instead of a date then dataZoa will automatically determine and set the most recent date in use by any row or cell.
 Generally using the keyword "LATEST" with non cross-sectional displays is not recommended; the only benefit is to force all rows to the same date but at the cost of some speed.
 ===Argument: RF (String)===
@@ Line 74: / Line 78: @@
 Meaning: Row Filter
-Purpose: Allows for filtering (hiding) rows in which all the values match the provided filter.
+Purpose: Allows for filtering (hiding) rows in which all the values match 1 or more of the provided filters.
 Supported By: Tables, LatestValues
 ===Argument: NC (Integer)===
@@ Line 89: / Line 98: @@
 Non-integer values as well as integer values outside the range of 1-50 for Tables or 1-9 for LatestValues are ignored.
 ===Argument: FR (Float)===
@@ Line 103: / Line 113: @@
 A value of 2.0 means that the footer section (footnotes, citation, attribution, watermark, tools) is hidden.
 A value of 3.0 implies the same as a value of 2.0 but with a handle to display/hide the footer (overlaid on top of or instead of the embed).
 ===Argument: PW (Float)===
@@ Line 115: / Line 126: @@
 Between the PW and PH arguments, PW is more pivotal in making size based decisions.
 ===Argument: PH (Float)===
@@ Line 127: / Line 139: @@
 Between the PW and PH arguments, PW is more pivotal in making size based decisions.
 ===Argument: WD (Float)===
@@ Line 139: / Line 152: @@
 Reserved, not yet implemented
 ===Argument: WN (Float)===
@@ Line 151: / Line 165: @@
 Reserved, not yet implemented
 ===Argument: WX (Float)===
@@ Line 163: / Line 178: @@
 Reserved, not yet implemented
 ===Argument: HE (Float)===
@@ Line 175: / Line 191: @@
 Reserved, not yet implemented
 ===Argument: HN (Float)===
@@ Line 187: / Line 204: @@
 Reserved, not yet implemented
 ===Argument: HX (Float)===

@@ Line 69: / Line 69: @@
 If the keyword "LATEST" is provided instead of a date then dataZoa will automatically determine and set the most recent date in use by any row or cell.
 Generally using the keyword "LATEST" with non cross-sectional displays is not recommended; the only benefit is to force all rows to the same date but at the cost of some speed.
 ===Argument: NC (Integer)===

← Older revision		Revision as of 22:30, 29 November 2016
Line 193:		Line 193:

	[[Category:Advanced]]		[[Category:Advanced]]
		+	[[Category:Displays]]

← Older revision		Revision as of 17:44, 9 September 2016
Line 191:		Line 191:

	Reserved, not yet implemented		Reserved, not yet implemented
		+
		+	[[Category:Advanced]]

@@ Line 5: / Line 5: @@
 * Each unique combination of arguments will become a server cached variation of the underlying embed.
-===Argument: GLName (String)'===
+===Argument: GLName (String)===
 Meaning: GroupList Name indicating a set of series to show in the display

@@ Line 6: / Line 6: @@
-'''Argument: GLName (String)'''¶
+===Argument: GLName (String)'===
 Meaning: GroupList Name indicating a set of series to show in the display
@@ Line 20: / Line 20: @@
 In the case of LatestValues displays, multiple GroupLists can be passed (delimited by "##SPLIT##") to generate a cross-sectional display.
-'''Argument: AltTitle (String)'''
+===Argument: AltTitle (String)===
 Meaning: Alternate Title
@@ Line 33: / Line 33: @@
 ===Argument: AltExtSrc (String)===
 Meaning: Alternate External Sources
@@ Line 52: / Line 50: @@
 Future expansion may allow for providing names of alternate external sources which aren't specifically GroupList names.
+===Argument: XSectDate (Date)===
-−
-−
-−
-Edit
-Argument: XSectDate (Date)¶
 Meaning: Cross-sectional Date
@@ Line 78: / Line 71: @@
 Generally using the keyword "LATEST" with non cross-sectional displays is not recommended; the only benefit is to force all rows to the same date but at the cost of some speed.
+===Argument: NC (Integer)===
-−
-−
-−
-Edit
-Argument: NC (Integer)¶
 Meaning: Number of Columns
@@ Line 95: / Line 83: @@
 Non-integer values as well as integer values outside the range of 1-50 for Tables or 1-9 for LatestValues are ignored.
+===Argument: FR (Float)===
-−
-−
-−
-Edit
-Argument: FR (Float)¶
 Meaning: Framing Options
@@ Line 114: / Line 97: @@
 A value of 3.0 implies the same as a value of 2.0 but with a handle to display/hide the footer (overlaid on top of or instead of the embed).
+===Argument: PW (Float)===
-−
-−
-−
-Edit
-Argument: PW (Float)¶
 Meaning: Parent Viewport Width
@@ Line 131: / Line 109: @@
 Between the PW and PH arguments, PW is more pivotal in making size based decisions.
+===Argument: PH (Float)===
-−
-−
-−
-Edit
-Argument: PH (Float)¶
 Meaning: Parent Viewport Height
@@ Line 148: / Line 121: @@
 Between the PW and PH arguments, PW is more pivotal in making size based decisions.
+===Argument: WD (Float)===
-−
-−
-−
-Edit
-Argument: WD (Float)¶
 Meaning: Width
@@ Line 165: / Line 133: @@
 Reserved, not yet implemented
+===Argument: WN (Float)===
-−
-Edit
-Argument: WN (Float)¶
 Meaning: Minimum Width
@@ Line 180: / Line 145: @@
 Reserved, not yet implemented
+===Argument: WX (Float)===
-−
-Edit
-Argument: WX (Float)¶
 Meaning: Maximum Width
@@ Line 195: / Line 157: @@
 Reserved, not yet implemented
+===Argument: HE (Float)===
-−
-−
-−
-Edit
-Argument: HE (Float)¶
 Meaning: Height
@@ Line 212: / Line 169: @@
 Reserved, not yet implemented
+===Argument: HN (Float)===
-−
-−
-−
-Edit
-Argument: HN (Float)¶
 Meaning: Minimum Height
@@ Line 229: / Line 181: @@
 Reserved, not yet implemented
+===Argument: HX (Float)===
-−
-Edit
-Argument: HX (Float)¶
 Meaning: Maximum Height