document weak compose behavior for #544

src/composite-chart.js

@@ -246,6 +246,8 @@ dc.compositeChart = function (parent, chartGroup) {
     /**
      * Get or set chart-specific options for all child charts. This is equivalent to calling
      * {@link dc.baseMixin#options .options} on each child chart.
+     *
+     * Note: currently you must call this before `compose` in order for the options to be propagated.
      * @method childOptions
      * @memberof dc.compositeChart
      * @instance
@@ -294,6 +296,11 @@ dc.compositeChart = function (parent, chartGroup) {
 
     /**
      * Combine the given charts into one single composite coordinate grid chart.
+     *
+     * Note: currently due to the way it is implemented, you must call this function at the end of
+     * initialization of the composite chart, in particular after `shareTitle`, `childOptions`,
+     * `width`, `height`, and `margins`, in order for the settings to get propagated to the children
+     * correctly.
      * @method compose
      * @memberof dc.compositeChart
      * @instance
@@ -367,6 +374,9 @@ dc.compositeChart = function (parent, chartGroup) {
     /**
      * Get or set title sharing for the chart. If set, the {@link dc.baseMixin#title .title()} value from
      * this chart will be shared with composed children.
+     *
+     * Note: currently you must call this before `compose` or the child will still get the parent's
+     * `title` function!
      * @method shareTitle
      * @memberof dc.compositeChart
      * @instance