@{ * Get/set number notation to use. * Options are: * - Mixed (0, default) * - Scientific (1) * - Fixed-point (2) */
| 181 | * - Fixed-point (2) |
| 182 | */ |
| 183 | vtkSetClampMacro(Notation, int, 0, 2); |
| 184 | vtkGetMacro(Notation, int); |
| 185 | ///@} |
| 186 | |
| 187 | ///@{ |
| 188 | /** |
| 189 | * Set/Get the std::format or printf style format with which to print the labels on the scalar |
| 190 | * bar. |
| 191 | */ |
| 192 | vtkSetStringMacro(LabelFormat); |
| 193 | vtkGetStringMacro(LabelFormat); |
| 194 | ///@} |
| 195 | |
| 196 | ///@{ |
| 197 | /** |
| 198 | * Set/Get if the labels and ticks should be snapped to |
| 199 | * match rounded values. It updates `AdjustedRange` |
| 200 | * |
| 201 | * It differs from `AdjustLabels` in that takes NumberOfLabels into account |
| 202 | * and try to produce the nearest count of labels. |
| 203 | * When SnapLabelsToGrid is on, `AdjustLabels` is ignored. |
| 204 | * |
| 205 | * When `AdjustedRange` is larger than `Range`, some ticks may be |
| 206 | * outside of `Range`. They are not displayed. |
| 207 | * |
| 208 | * Default is false. |
| 209 | * |
| 210 | * see GetAdjustedRange, GetAdjustedNumberOfLabels |
| 211 | */ |
| 212 | vtkSetMacro(SnapLabelsToGrid, bool); |
| 213 | vtkGetMacro(SnapLabelsToGrid, bool); |
| 214 | vtkBooleanMacro(SnapLabelsToGrid, bool); |
| 215 | ///@} |
| 216 | |
| 217 | ///@{ |
| 218 | /** |
| 219 | * Set/Get the flag that controls whether the labels and ticks are |
| 220 | * adjusted for "nice" numerical values to make it easier to read |
| 221 | * the labels. |
| 222 | * |
| 223 | * When on (default), the `Range` is slightly modified (see `AdjustedRange`), |
| 224 | * and it creates `AdjustedNumberOfLabels` ticks. |
| 225 | * When `AdjustedRange` is larger than `Range`, some ticks may be |
| 226 | * outside of `Range`. They are not displayed. |
| 227 | * |
| 228 | * Default is true. |
| 229 | * This is ignored if SnapLabelsToGrid is true. Please prefer SnapLabelsToGrid. |
| 230 | * |
| 231 | * see GetAdjustedRange, GetAdjustedNumberOfLabels |
| 232 | */ |
| 233 | vtkSetMacro(AdjustLabels, vtkTypeBool); |
| 234 | vtkGetMacro(AdjustLabels, vtkTypeBool); |
| 235 | vtkBooleanMacro(AdjustLabels, vtkTypeBool); |
| 236 | ///@} |
| 237 | |
| 238 | ///@{ |
| 239 | /** |
| 240 | * Set/Get if the first tick should be drawn. |
no test coverage detected